Skip to content

Commit 9b57cc9

Browse files
core-manMeghan Jonesseisman
authored
Add more example code standards (#1126)
Co-authored-by: Meghan Jones <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
1 parent 3414f69 commit 9b57cc9

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,12 @@ When editing documentation, use the following standards to demonstrate the examp
181181

182182
1. Python arguments, such as import statements, Boolean expressions, and function
183183
arguments should be wrapped as ``code`` by using \`\` on both sides of the code.
184-
Example: \`\`import pygmt\`\` results in ``import pygmt``.
184+
Examples: \`\`import pygmt\`\` results in ``import pygmt``, \`\`True\`\` results in `True`,
185+
\`\`style="v"\`\` results in `style="v"`.
185186
2. Literal GMT arguments should be **bold** by wrapping the arguments with \*\*
186187
(two asterisks) on both sides. The argument description should be in *italicized*
187188
with \* (single asterisk) on both sides.
188-
Example: `**+l**\ *label*` results in **+l***label*.
189+
Examples: `**+l**\ *label*` results in **+l***label*, `**05m**` results in **05m**.
189190
3. Optional arguments are placed wrapped with [ ] (square brackets).
190191
4. Arguments that are mutually exclusive are separated with a | (bar) to denote "or".
191192

0 commit comments

Comments
 (0)