Skip to content

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Apr 25, 2023

Description of proposed changes

This PR aims to improve the formulations of the criteria list in the documenation of pygmt.select.

Related to PR #2466

Preview: https://pygmt-dev--2518.org.readthedocs.build/en/2518/api/generated/pygmt.select.html#pygmt.select

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 Apr 25, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Apr 25, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as draft May 18, 2023 10:33
@yvonnefroehlich yvonnefroehlich changed the title WIP: Improve docs of "pygmt.select" Improve docs of "pygmt.select" Aug 2, 2023
@yvonnefroehlich yvonnefroehlich changed the title Improve docs of "pygmt.select" pygmt.select: Fix typos Aug 2, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review August 2, 2023 12:42
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Aug 2, 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 Aug 2, 2023
@seisman seisman added this to the 0.10.0 milestone Aug 2, 2023
@seisman seisman merged commit d580dff into main Aug 4, 2023
@seisman seisman deleted the fix-typos-29-select branch August 4, 2023 00:05
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 4, 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.

4 participants