Skip to content

Conversation

@yvonnefroehlich
Copy link
Member

Description of proposed changes

Currently we use different indents for the bullet point lists in the docstrings, e.g.,

docstrings_indent

This PR aims to make this consistent.

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.

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 this to the 0.17.0 milestone Sep 21, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Sep 21, 2025
@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 21, 2025
@yvonnefroehlich yvonnefroehlich marked this pull request as draft September 21, 2025 12:06
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review September 21, 2025 13:28
@seisman seisman merged commit bb6e084 into main Sep 21, 2025
23 of 24 checks passed
@seisman seisman deleted the fix-indent branch September 21, 2025 13:42
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