Skip to content

Update region and projection standard docstrings - #1510

Merged
weiji14 merged 8 commits into
mainfrom
rj-required-docstring
Oct 12, 2021
Merged

Update region and projection standard docstrings#1510
weiji14 merged 8 commits into
mainfrom
rj-required-docstring

Conversation

@willschlitzer

Copy link
Copy Markdown
Contributor

This pull request modifies the COMMON_OPTIONS text for region and projection. It also adds that it is requirement for certain plotting commands to individual modules. This partially addresses #1493.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzerwillschlitzer added the documentation Improvements or additions to documentation label Sep 14, 2021
@willschlitzerwillschlitzer added this to the 0.5.0 milestone Sep 14, 2021
@willschlitzerwillschlitzer self-assigned this Sep 14, 2021
Comment threadpygmt/src/histogram.py Outdated
Comment threadpygmt/src/solar.py Outdated
@seisman

Copy link
Copy Markdown
Member

The doctest in

*Required if this is the first plot command*.
fails. You need to remove the text *Required if this is the first plot command*. from the fmt_docstring doctest.

@weiji14weiji14 mentioned this pull request Sep 27, 2021
19 tasks
@willschlitzerwillschlitzer mentioned this pull request Oct 7, 2021
35 tasks
@weiji14weiji14 added the final review call This PR requires final review and approval from a second reviewer label Oct 8, 2021
Comment threadpygmt/src/basemap.py Outdated
Comment threadpygmt/src/coast.py Outdated
Comment threadpygmt/src/text.py Outdated

@seismanseisman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me after applying @meghanrjones's suggestions.

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@weiji14
weiji14 merged commit dd2b374 into mainOct 12, 2021
@weiji14
weiji14 deleted the rj-required-docstring branch October 12, 2021 02:51
@weiji14weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Oct 12, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…#1510)
Modify the COMMON_OPTIONS text for region and projection to
remove the "Required if this is the first plot command" text, but
adding it solely to `basemap`, `coast` and `text` where it is actually
required.
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@willschlitzer@seisman@maxrjones@weiji14