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

Figure.histogram and Figure.ternary: Fix incorrect docstrings 'color' to 'fill' #2124

Merged
merged 3 commits into from
Sep 22, 2022

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 19, 2022

Description of proposed changes
In Figure.histogram and Figure.ternary, -G is aliased to fill, not color, so we should show the docstring of fill instead.

Address #1617.

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • 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 documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 19, 2022
@seisman seisman added this to the 0.8.0 milestone Sep 19, 2022
@willschlitzer willschlitzer added the final review call This PR requires final review and approval from a second reviewer label Sep 21, 2022
@seisman seisman merged commit d5e3745 into main Sep 22, 2022
@seisman seisman deleted the fix-color-fill branch September 22, 2022 07:00
@willschlitzer willschlitzer removed the final review call This PR requires final review and approval from a second reviewer label Sep 22, 2022
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 skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants