-
Notifications
You must be signed in to change notification settings - Fork 297
typo fix in asc_desc2horz_vert & more doc in tsview
#1370
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโll occasionally send you account related emails.
Already on GitHub? Sign in to your account
typo fix in asc_desc2horz_vert & more doc in tsview
#1370
Conversation
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
|
|
Merged |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thank you @mohseniaref.
asc_desc2horz_vert & more doc in tsview
โจ 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: