Skip to content

pygmt.set_display: Add inline examples and improve documentation#2458

Merged
seisman merged 4 commits intomainfrom
docs/set-display
Mar 25, 2023
Merged

pygmt.set_display: Add inline examples and improve documentation#2458
seisman merged 4 commits intomainfrom
docs/set-display

Conversation

@seisman
Copy link
Member

@seisman seisman commented Mar 23, 2023

Description of proposed changes

Address #1666.

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.
  • 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

@seisman seisman added this to the 0.9.0 milestone Mar 24, 2023
@seisman seisman marked this pull request as ready for review March 24, 2023 03:04
@seisman seisman added the documentation Improvements or additions to documentation label Mar 24, 2023
@seisman seisman changed the title pygmt.set_display: Add inline examples pygmt.set_display: Add inline examples and improve documentation Mar 24, 2023
@seisman seisman added the needs review This PR has higher priority and needs review. label Mar 24, 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 Mar 24, 2023
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman merged commit d99856d into main Mar 25, 2023
@seisman seisman deleted the docs/set-display branch March 25, 2023 15:05
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 25, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants