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

POC: Add common docstrings for meca/coupe #3825

Closed
wants to merge 5 commits into from

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Feb 27, 2025

Description of proposed changes

Related to #3817.

Preview:

https://pygmt-dev--3825.org.readthedocs.build/en/3825/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.

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

@michaelgrund
Copy link
Member Author

/format

@michaelgrund michaelgrund mentioned this pull request Feb 27, 2025
9 tasks
@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Feb 27, 2025
@michaelgrund michaelgrund marked this pull request as draft February 27, 2025 10:16
@michaelgrund
Copy link
Member Author

Closed as the issue will be addressed in another format (see #3829)

@seisman seisman deleted the comm-docs-meca-coupe branch March 3, 2025 08:24
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.

1 participant