Skip to content

Add defaults convention to example code standards#1182

Merged
seisman merged 3 commits intomasterfrom
contrib-defaults
Apr 5, 2021
Merged

Add defaults convention to example code standards#1182
seisman merged 3 commits intomasterfrom
contrib-defaults

Conversation

@maxrjones
Copy link
Member

Description of proposed changes

This PR adds the convention for specifying defaults in the PyGMT documentation to the contributing guidelines.

Fixes #631

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

@maxrjones maxrjones added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Apr 5, 2021
@seisman seisman added this to the 0.4.0 milestone Apr 5, 2021
Meghan Jones and others added 2 commits April 5, 2021 12:49
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman merged commit c1b20e5 into master Apr 5, 2021
@seisman seisman deleted the contrib-defaults branch April 5, 2021 17:26
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…s#1182)

* Add defaults convention to example code standards

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.

How to reproduce original GMT arguments in PyGMT documentation

2 participants