GenericMappingTools / GenericMappingTools/pygmt

Add region docstring to COMMON_OPTIONS for non-plotting modules

Open
#1,493 8 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
874
Forks
255
Avg merge
1d 21h
Merged PRs (30d)
40

Description

The use of `{R}` in docstrings begins with "Required if this is the first plot command.", which doesn't make sense for not plotting modules. I think there should be an `{R-noplot}`-type option that just states that the region can be set.

**Are you willing to help implement and maintain this feature?** Yes

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.