-
Notifications
You must be signed in to change notification settings - Fork 214
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
Error in contour documentation (-A argument) #879
Comments
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our contributing guidelines and code of conduct. |
If the alias addition is alright, I can fix this issue. It also might be a good time to clean "[TODO: Insert more documentation]" in the contour docs before v0.3.0. While the argument descriptions can be cleaned up a bit, I actually don't think that anything more is really needed in the preamble since there's a link to the GMT docs and the amount of information provided is on par with most of the other methods. |
Great. One thing that I do not understand from the contributing guidelines - how do you decide which argument flags go into the PyGMT docstrings? For example, the pygmt docs for grdcontour for 'annotation' has a subset of the many flags for gmt's grdcontour -A. |
The goal is to wrap all of them if possible. But historically, we were lazy and only aliased a subset, usually the required arguments, or those that were subjectively deemed as important. It's better to start with something than nothing I guess, as we can always iterate and add more later. Some modules in GMT have dozens of arguments and it can take a lot of time to review them all! |
So, if I understand correctly, the subset of the flags that are included in the documentation are the ones that have been tested? Perhaps a better example of my confusion is basemap. map_scale and rose take really similar option flags and map_scale lists a subset of the flags from basemap -L whereas rose does not list any flags from basemap -T. Still, map_scale does not list all the option flags from basemap -L and likely wouldn't work with only '[g|j|J|n|x]refpoint'. |
Yes and no, it depends on many factors. On what should or should not be tested, see #796 and https://github.com/GenericMappingTools/pygmt/blame/a828f739057f6fd003d131063eab5e04df265540/CONTRIBUTING.md#L321-L325. Let's just say our standards have changed since PyGMT started in 2017, and there are some parts of our documentation from that early era (2018-2019) that have not been updated to the new standard (2021)! Which is why we need more eyes and contributors working on this!
Fair point. the |
Thanks for the explanation and the links to the PRs! Those will be helpful to review. |
Description of the problem
This description of the A option for
pygmt.Figure.contour
in the PyGMT docs is incorrect.PyGMT description:
GMT description:
Since A argument is the same for contour and grdcontour, I propose to add the same alias as in grdcontour for A (annotation).
The text was updated successfully, but these errors were encountered: