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

GMTDataArrayAccessor: Add inline examples for setting GMT specific properties (#2370) #2370

Merged
merged 2 commits into from
Feb 17, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Feb 16, 2023

Description of proposed changes

Fixes #

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 the documentation Improvements or additions to documentation label Feb 16, 2023
@seisman seisman changed the title Add inline examples for GMTDataArrayAccessor GMTDataArrayAccessor: Add inline examples for setting GMT specific properties Feb 16, 2023
pygmt/accessors.py Outdated Show resolved Hide resolved
Co-authored-by: Michael Grund <[email protected]>

You can also set the GMT specific properties for grids created by yourself:

>>> import numpy as np
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this inline example is modified from #390.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@seisman seisman marked this pull request as draft February 16, 2023 09:44
@seisman seisman changed the title GMTDataArrayAccessor: Add inline examples for setting GMT specific properties WIP: GMTDataArrayAccessor: Add inline examples for setting GMT specific properties Feb 16, 2023
@seisman seisman added this to the 0.9.0 milestone Feb 16, 2023
@seisman
Copy link
Member Author

seisman commented Feb 16, 2023

I plan to add more inline examples after addressing some related issues, so mark it as WIP.

@seisman seisman marked this pull request as ready for review February 17, 2023 05:08
@seisman seisman changed the title WIP: GMTDataArrayAccessor: Add inline examples for setting GMT specific properties GMTDataArrayAccessor: Add inline examples for setting GMT specific properties Feb 17, 2023
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Feb 17, 2023
@seisman
Copy link
Member Author

seisman commented Feb 17, 2023

I plan to add more inline examples after addressing some related issues, so mark it as WIP.

Changed my mind. I'll add more example when addresing accessor-related issues. Marking this PR as "final review call".

Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@seisman seisman changed the title GMTDataArrayAccessor: Add inline examples for setting GMT specific properties GMTDataArrayAccessor: Add inline examples for setting GMT specific properties (#2370)Co-authored-by: Michael Grund <[email protected]> Feb 17, 2023
@seisman seisman merged commit 07f957e into main Feb 17, 2023
@seisman seisman deleted the docs/accessor branch February 17, 2023 13:18
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 17, 2023
@seisman seisman changed the title GMTDataArrayAccessor: Add inline examples for setting GMT specific properties (#2370)Co-authored-by: Michael Grund <[email protected]> GMTDataArrayAccessor: Add inline examples for setting GMT specific properties (#2370) Feb 17, 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