-
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
Complete most of documentation for makecpt #676
Conversation
Starting to properly document all major arguments for `makecpt` as per upstream GMT docs at https://docs.generic-mapping-tools.org/6.1/makecpt.html. Begin by refreshing current aliases series (T), truncate (G), reverse (I) and continuous (Z).
For
|
Yeah, it does get confusing. I couldn't think of a word that covers background/foreground (and NaN) though. Same with W which could be categorical/wrap/cyclic :/ |
For -W, we could use |
Sure, I did think of that actually, but we'll need an extra check so that categorical (W) and cyclic (Ww) are not used at the same time. |
b0c8a70
to
be5141c
Compare
Description of proposed changes
Finish up aliasing most arguments for
makecpt
, improving the documentattion to be better than what we currently have at https://www.pygmt.org/v0.2.0/api/generated/pygmt.makecpt.html! For reference, upstream GMT docs is at https://docs.generic-mapping-tools.org/6.1/makecpt.html and https://github.com/GenericMappingTools/gmt/blame/master/doc/rst/source/makecpt.rst.Live documentation preview is at https://pygmt-git-complete-docs-makecpt.gmt.vercel.app/api/generated/pygmt.makecpt.html
TODO:
Arguments/Aliases to document (see also https://www.generic-mapping-tools.org/GMT.jl/latest/makecpt/). New aliases are highlighted in bold:
foreground?Fixes #
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Notes
/format
in the first line of a comment to lint the code automatically