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

Improve the first figure tutorial #1025

Merged
merged 7 commits into from
Mar 10, 2021

Conversation

core-man
Copy link
Member

@core-man core-man commented Mar 9, 2021

Description of proposed changes

As suggested by @weiji14 in #996 (comment), I will submit my revisions for the documentation of each file in one single PR. After all the revisions posted in #996 are submitted in each PR, I will close it.

This is a revision of first figure tutorial originally posted in #996.

Related to #983.

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

@core-man core-man mentioned this pull request Mar 9, 2021
5 tasks
@seisman seisman added the documentation Improvements or additions to documentation label Mar 9, 2021
@seisman seisman added this to the 0.3.1 milestone Mar 9, 2021
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Copy link
Member

@maxrjones maxrjones 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 to me!

Copy link
Member

@michaelgrund michaelgrund 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 to me!

examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
examples/tutorials/first-figure.py Outdated Show resolved Hide resolved
Co-authored-by: Michael Grund <michael_grund@gmx.de>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added the skip-changelog Skip adding Pull Request to changelog label Mar 9, 2021
@seisman seisman marked this pull request as draft March 9, 2021 19:12
@seisman seisman marked this pull request as ready for review March 9, 2021 23:12
@seisman seisman changed the title Improve first figure documentation Improve the first figure tutorial Mar 10, 2021
@seisman seisman merged commit 98d83f6 into GenericMappingTools:master Mar 10, 2021
@core-man core-man deleted the improve-tutorial-doc branch March 14, 2021 09:08
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Co-authored-by: Michael Grund <michael_grund@gmx.de>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
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