Skip to content

Add documentation for common options/parameter in the "Technical Reference" section #3843

Open
@seisman

Description

@seisman

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

Image

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedHelping hands are appreciated

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions