-
Notifications
You must be signed in to change notification settings - Fork 224
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
Add common alias "verbose" (V) to grdlandmask and savefig #1343
Add common alias "verbose" (V) to grdlandmask and savefig #1343
Conversation
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.
Hi @sean0921! Thanks for your PR, I was just reading your blog post https://sean0921.github.io/2021/06/21/pygmt-2021-6-feedback/ just now and really appreciate the honest feedback. A few of us seismologists (cc @core-man) are keen on implementing sac (see #967 (comment)) and will look into it in the coming months. You're welcome to help out if you have time, or open up specific feature request issues for modules like sac
and project
at https://github.com/GenericMappingTools/pygmt/issues/new/choose.
Anyways, back to this PR. Please add a line with {V}
to the docstring so that the verbose documentation will show up. It should look similar to this
Lines 154 to 156 in b2808cf
{R} | |
{V} | |
{XY} |
@sean0921 Thanks for your PR. Your blog post is great. Welcome to contribute to PyGMT and I believe you could make great help for the project. |
20f873d
to
93d76ea
Compare
93d76ea
to
c69a8f9
Compare
c69a8f9
to
cf679a1
Compare
|
cf679a1
to
848d210
Compare
848d210
to
50623cf
Compare
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.
also add{V}
docstring tosavefig
(a wrapper ofpsconvert
?)
also letsavefig
API documentation show aliases
It seems not work and there's already a tip for readers to look atpsconvert
page insavefig
page
I think it works, the documentation build at https://pygmt-eowmibjw9-gmt.vercel.app/api/generated/pygmt.Figure.psconvert.html shows the 'verbose' parameter documentation.
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.
Looks good to me!
🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉 Please open a new pull request to add yourself to the |
…pingTools#1343) Co-authored-by: Wei Ji <[email protected]>
Description of proposed changes
Add common alias "verbose" (V) to
grdlandmask
andsavefig
before #1281 is solved.Reminders
make format
andmake check
to make sure the code follows the style guide.Add new public functions/methods/classes todoc/api/index.rst
.If adding new functionality, add an example to docstrings or tutorials.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version