typo fix in asc_desc2horz_vert & more doc in tsview#1370
Merged
yunjunz merged 7 commits intoinsarlab:mainfrom Jun 10, 2025
Merged
Conversation
Contributor
Reviewer's GuideThis pull request corrects a spelling mistake in the overlapping area message and enriches the tsview module with docstrings for its initialization routine and plotting helpers. Class Diagram of Modified Functions in mintpy ModulesclassDiagram
namespace mintpy {
class tsview {
+read_init_info(inps) : (inps, atr)
+plot_ts_errorbar(ax, dis_ts, inps, ppar) : void
+plot_ts_scatter(ax, dis_ts, inps, ppar) : void
}
class asc_desc2horz_vert {
+run_asc_desc2horz_vert(inps) : void
}
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
Author
|
Merged |
Contributor
There was a problem hiding this comment.
Hey @mohseniaref - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
yunjunz
approved these changes
Jun 10, 2025
Member
yunjunz
left a comment
There was a problem hiding this comment.
LGTM. Thank you @mohseniaref.
asc_desc2horz_vert & more doc in tsview
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✨ Description of Proposed Changes
✅ Fixed a typo in the overlapping area message in asc_desc2horz_vert.py.
📄 Added a docstring to document the initialization routine in tsview.py.
🛠️ Documented the errorbar plotting helper function in tsview.py.
🛠️ Documented the scatter plotting helper function in tsview.py.
Summary by Sourcery
Improve code documentation by adding missing docstrings to key tsview routines and correct a typo in the overlapping area output message
Bug Fixes:
Enhancements: