Skip to content

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Sep 13, 2023

Description of proposed changes

Related to @michaelgrund's review at #2674 (comment), this PR aims to update the documenations of the other datasets in the same way. Eventually TODO: Add comma related to review at #2674 (comment). DONE: See commit ee8ab66.

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 Sep 13, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.11.0 milestone Sep 13, 2023
@yvonnefroehlich yvonnefroehlich changed the title WIP: Fix typos in documentations of datasets Fix typos in documentations of datasets Sep 14, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Sep 14, 2023
@michaelgrund michaelgrund added the final review call This PR requires final review and approval from a second reviewer label Sep 14, 2023
@yvonnefroehlich
Copy link
Member Author

/format

@seisman seisman merged commit 594d3f1 into main Sep 14, 2023
@seisman seisman deleted the fix-typos-43-docs-ds branch September 14, 2023 13:34
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 14, 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