-
Notifications
You must be signed in to change notification settings - Fork 234
Description
GMT modules have common options (e.g., -J/-R/-V), which are aliased to standardized parameters in PyGMT (e.g., projection, region, verbose). Currently, the docstrings for some parameters are lengthy and take up a significant portion of the documentation pages, making it harder to focus on module-specific options.
To improve readability, I propose moving the detailed explanations of these common parameters to a dedicated page in the "Technical Reference" section. In the wrapper documentation, their descriptions can be condensed, with a link to the full explanation.
For example, currently, the verbose has docstrings like below
and it can be simplified to:
verbose
Select verbosity level. [See detailed explanation.]
This approach reduces the documentation length of wrappers, and makes wrapper-specific parameters more prominent.
TODO list
Here is a complete list of GMT common options (https://docs.generic-mapping-tools.org/latest/std-opts.html).
-
-B -
-J -
-R -
Unused in PyGMT-U -
-VDOC: Add a page for common parameters in the Technical Reference section #3844 @seisman -
: Unused in PyGMT-X -
: Unused in PyGMT-Y -
-a -
-b -
-cDOC: Improve the docstrings of the 'panel' parameter #3930 -
-d -
-e -
-f -
-g -
-h -
-i -
-jDOC: Move description of distcal to the Technical Reference section #3868 @seisman -
-l -
-n -
-o -
-p -
-q -
-r -
-s -
-t -
-w -
-xImprove the description for the 'cores' parameter #3923 -
Unused in PyGMT-:
