Uh oh!
There was an error while loading. Please reload this page.
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).
seisman
commented
Nov 2, 2020
For |
weiji14
commented
Nov 2, 2020
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 :/ |
seisman
commented
Nov 2, 2020
For -W, we could use |
weiji14
commented
Nov 2, 2020
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
be5141cCompareUh oh!
There was an error while loading. Please reload this page.
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 formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Notes
/formatin the first line of a comment to lint the code automatically