Skip to content

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented May 30, 2023

Description of proposed changes

This PR aims to expand the docstrings for the parameters compressionfill , cmap, and offset of pygmt.Figure.meca regarding the fill of the small circle, which can be plotted at the initial location in case the beachball is plotted with an offset to the initial location. I really like this feature, and feel it would be nice to state this explicitly in the documentation.

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 commands are:

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

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels May 30, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.10.0 milestone May 30, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this May 30, 2023
@yvonnefroehlich yvonnefroehlich changed the title Expand docstrings for "compressionfill" and "offset" of "Figure.meca" Expand docstrings for "compressionfill", "camp" and "offset" of "Figure.meca" May 30, 2023
@yvonnefroehlich yvonnefroehlich changed the title Expand docstrings for "compressionfill", "camp" and "offset" of "Figure.meca" Expand docstrings for "compressionfill", "camp", and "offset" of "Figure.meca" May 30, 2023
@yvonnefroehlich yvonnefroehlich changed the title Expand docstrings for "compressionfill", "camp", and "offset" of "Figure.meca" Expand docstrings for "compressionfill", "cmap", and "offset" of "Figure.meca" May 30, 2023
@yvonnefroehlich yvonnefroehlich changed the title Expand docstrings for "compressionfill", "cmap", and "offset" of "Figure.meca" "Figure.meca": Expand docstrings for "compressionfill", "cmap", and "offset" May 31, 2023
@michaelgrund michaelgrund added the final review call This PR requires final review and approval from a second reviewer label May 31, 2023
@seisman seisman changed the title "Figure.meca": Expand docstrings for "compressionfill", "cmap", and "offset" Figure.meca: Expand docstrings for "compressionfill", "cmap", and "offset" Jun 1, 2023
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 1, 2023
@seisman seisman merged commit cf5c107 into main Jun 1, 2023
@seisman seisman deleted the expand-meca-docs-compressionfill-offset branch June 1, 2023 02:34
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