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.meca: Expand docstring for the scale parameter #2552

Merged
merged 6 commits into from
Jun 12, 2023

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented May 30, 2023

Description of proposed changes

This PR aims to expand the docstring for the scale parameter of pygmt.Figure.meca.

Upstream GMT documentation: https://docs.generic-mapping-tools.org/dev/supplements/seis/meca.html#s

Preview: https://pygmt-dev--2552.org.readthedocs.build/en/2552/api/generated/pygmt.Figure.meca.html

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 WIP: Expand docstring of 'scale' parameter of 'Figure.meca' WIP: Expand docstring for "scale" of "Figure.meca" May 30, 2023
@yvonnefroehlich yvonnefroehlich changed the title WIP: Expand docstring for "scale" of "Figure.meca" WIP: "Figure.meca": Expand docstring for "scale" May 31, 2023
pygmt/src/meca.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich changed the title WIP: "Figure.meca": Expand docstring for "scale" "Figure.meca": Expand docstring for "scale" Jun 3, 2023
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Jun 3, 2023
@seisman
Copy link
Member

seisman commented Jun 6, 2023

Related to #1466, but I'm not sure if we need a more Pythonic solution.

Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

Looks good to me. We can have a more Pythonic Figure.meca function later if we want.

@seisman seisman changed the title "Figure.meca": Expand docstring for "scale" Figure.meca: Expand docstring for the scale parameter Jun 8, 2023
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Jun 8, 2023
@seisman
Copy link
Member

seisman commented Jun 10, 2023

Ping @GenericMappingTools/pygmt-maintainers to review this PR.

@michaelgrund michaelgrund merged commit 1893e9b into main Jun 12, 2023
@michaelgrund michaelgrund deleted the expand-meca-docs-scale branch June 12, 2023 06:58
@michaelgrund michaelgrund removed the final review call This PR requires final review and approval from a second reviewer label Jun 12, 2023
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