Skip to content

Document gmtwhich -Ga option to download to appropriate cache folder#1554

Merged
weiji14 merged 2 commits intomainfrom
gmtwhich-download-a
Oct 3, 2021
Merged

Document gmtwhich -Ga option to download to appropriate cache folder#1554
weiji14 merged 2 commits intomainfrom
gmtwhich-download-a

Conversation

@weiji14
Copy link
Member

@weiji14 weiji14 commented Oct 1, 2021

Description of proposed changes

The gmtwhich -Ga option was added in GMT 6.1 at GenericMappingTools/gmt@d390ea4, but hasn't been documented in PyGMT since. See https://docs.generic-mapping-tools.org/6.2/gmtwhich#g.

Fixes #

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

@weiji14 weiji14 added the documentation Improvements or additions to documentation label Oct 1, 2021
@weiji14 weiji14 added this to the 0.5.0 milestone Oct 1, 2021
@maxrjones
Copy link
Member

Oops, just noticed that this is a draft whereas I thought it was a completed documentation fix. Are you planning to add tests or something else to the PR?

@weiji14
Copy link
Member Author

weiji14 commented Oct 1, 2021

Oops, just noticed that this is a draft whereas I thought it was a completed documentation fix. Are you planning to add tests or something else to the PR?

Nope, pretty much just a quick doc update! So I'll mark it as ready for review.

@weiji14 weiji14 marked this pull request as ready for review October 1, 2021 19:34
@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Oct 1, 2021
@weiji14 weiji14 merged commit 3c26f84 into main Oct 3, 2021
@weiji14 weiji14 deleted the gmtwhich-download-a branch October 3, 2021 02:17
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Oct 3, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants