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.contour & Figur.grdcontour: Improve docstring of pen #3210

Merged
merged 2 commits into from
Apr 29, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Apr 29, 2024

Description of proposed changes

This PR improves the docstring for the pen parameter of Figure.contour and Figure.grdcontour.

Fixes #2704

Preview:

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.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Apr 29, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.12.0 milestone Apr 29, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Apr 29, 2024
@seisman seisman merged commit 48f12cc into main Apr 29, 2024
19 checks passed
@seisman seisman deleted the improve-doc-pen-grd_contour branch April 29, 2024 09:48
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.

Figure.grdcontour: improve the documentation of the pen parameter
2 participants