Skip to content

Commit

Permalink
Update CONTRIBUTING.md with formatting conventions (GenericMappingToo…
Browse files Browse the repository at this point in the history
…ls#775)

Co-authored-by: Dongdong Tian <[email protected]>
  • Loading branch information
2 people authored and Josh Sixsmith committed Dec 21, 2022
1 parent 185fb33 commit 4281d66
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,21 @@ Guidelines for a good tutorial:
Note that the `Figure.show()` function needs to be called for a plot to be inserted into
the documentation.

### Example code standards

When editing documentation, use the following standards to demonstrate the example code:

1. Python arguments, such as import statements, Boolean expressions, and function
arguments should be wrapped as ``code`` by using \`\` on both sides of the code.
Example: \`\`import pygmt\`\` results in ``import pygmt``

2. Literal GMT arguments should be **bold** by wrapping the arguments with \*\*
(two asterisks) on both sides. The argument description should be in *italicized*
with \* (single asterisk) on both sides.
Example: `**+l**\ *label*` results in **+l***label*

3. Optional arguments are placed wrapped with [ ] (square brackets).
4. Arguments that are mutually exclusive are separated with a | (bar) to denote "or".

## Contributing Code

Expand Down

0 comments on commit 4281d66

Please sign in to comment.