Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add alias annotation (A) to Figure.contour() #883

Merged
merged 3 commits into from
Feb 14, 2021

Conversation

maxrjones
Copy link
Member

@maxrjones maxrjones commented Feb 13, 2021

Description of proposed changes

This PR fixes the description of the A option for pygmt.Figure.contour in the PyGMT docs and adds the annotation alias for A. It also reorders the arguments to the use_alias decorator to be alphabetical in similarity to the other modules (some modules list R and J first but most seem to use strict alphabetical order independent of required versus optional arguments).

Fixes #879

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

@seisman seisman added the documentation Improvements or additions to documentation label Feb 13, 2021
@seisman seisman added this to the 0.3.0 milestone Feb 13, 2021
pygmt/src/contour.py Outdated Show resolved Hide resolved
Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

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

This looks good to go after committing the suggestion from @seisman

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added skip-changelog Skip adding Pull Request to changelog and removed skip-changelog Skip adding Pull Request to changelog labels Feb 14, 2021
@seisman seisman changed the title Update contour documentation Add alias annotation (A) to Figure.contour() Feb 14, 2021
@seisman seisman merged commit 02858eb into GenericMappingTools:master Feb 14, 2021
@maxrjones maxrjones deleted the docs-contour branch February 14, 2021 15:17
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.

Error in contour documentation (-A argument)
3 participants