Skip to content

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

Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
@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 <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[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 skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants