-
Notifications
You must be signed in to change notification settings - Fork 215
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
Turn all short aliases into long form #474
Conversation
To make things more readable, we'll shift our documentation to use long form arguments by default. Starting from the common aliases R, J, B, U, CPT, G and W.
Also added timestamp (U) alias to the plotting functions that have them. Co-Authored-By: Dongdong Tian <[email protected]>
Perhaps we should update all the short-form arguments (if they have aliases) in this PR, not to update them in multiple PRs. I can help with it if you also agree. |
Might as well. I'll work on |
OK. |
Also standardize formatting of grdtrack docstring in line with other docs.
Alright, |
Yes, just ignore it. |
Also document the required imagefile parameter that was missing.
pygmt/base_plotting.py
Outdated
@@ -634,7 +643,7 @@ def basemap(self, **kwargs): | |||
[optionally] gridlines. A simple map scale or directional rose may also | |||
be plotted. | |||
|
|||
At least one of the options *B*, *L*, or *T* must be specified. | |||
At least one of the options *frame*, *L*, or *T* must be specified. |
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.
I've only changed B
to frame here for basemap. GMT.jl uses map_scale for L
, rose for Td
and compass for Tm
(see https://www.generic-mapping-tools.org/GMT.jl/latest/#GMT.basemap), do we want to go with those?
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.
Yes to me.
Co-authored-by: Wei Ji <[email protected]>
Do you want to take a look at https://pygmt-git-longaliascommonopts.gmt.now.sh/api/index.html to see if we missed any stray short aliases (other than the ones we agreed not to change)? P.S. Not a user facing change, but we should also update all the tests to use the long alias names at some point. |
Made a small fix. Now it's good to me.
Yes, I agree. |
Description of proposed changes
To make things more readable, we'll shift our documentation to use long form arguments by default. Starting from the common aliases R, J, B, U, CPT, G and W. Will move on to all others spread across across the API Reference page.
See also upstream GMT docs at https://docs.generic-mapping-tools.org/latest/std-opts.html.
New looking documentation for this branch can be previewed at https://pygmt-git-longaliascommonopts.gmt.now.sh/api/index.html
Files to change:
Fixes #473
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.