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

Add inline example for grdtrack #1725

Merged
merged 7 commits into from
Mar 12, 2022
Merged

Add inline example for grdtrack #1725

merged 7 commits into from
Mar 12, 2022

Conversation

willschlitzer
Copy link
Contributor

This PR adds an inline code example to the docstring for grdtrack.

Addresses #1686

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 commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Feb 5, 2022
@willschlitzer willschlitzer added this to the 0.6.0 milestone Feb 5, 2022
@willschlitzer willschlitzer self-assigned this Feb 5, 2022
pygmt/src/grdtrack.py Outdated Show resolved Hide resolved
Co-authored-by: Michael Grund <[email protected]>
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed final review call This PR requires final review and approval from a second reviewer labels Mar 7, 2022
pygmt/src/grdtrack.py Outdated Show resolved Hide resolved
pygmt/src/grdtrack.py Outdated Show resolved Hide resolved
pygmt/src/grdtrack.py Outdated Show resolved Hide resolved
pygmt/src/grdtrack.py Outdated Show resolved Hide resolved
@willschlitzer
Copy link
Contributor Author

@seisman I'm guessing I'm missing something, but why are you suggesting removing all of the # doctest: +SKIP from the inline example?

@seisman
Copy link
Member

seisman commented Mar 9, 2022

@seisman I'm guessing I'm missing something, but why are you suggesting removing all of the # doctest: +SKIP from the inline example?

Yes, we have adopted a new doctest method in #1790.

@weiji14 weiji14 modified the milestones: 0.6.0, 0.6.1 Mar 11, 2022
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 11, 2022
pygmt/src/grdtrack.py Outdated Show resolved Hide resolved
@weiji14 weiji14 modified the milestones: 0.6.1, 0.6.0 Mar 11, 2022
Co-authored-by: Meghan Jones <[email protected]>
@weiji14 weiji14 merged commit d85bfdf into main Mar 12, 2022
@weiji14 weiji14 deleted the inline-example/grdtrack branch March 12, 2022 06:33
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Mar 12, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Meghan Jones <[email protected]>
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.

5 participants