From 4d746097da7711d566befe590142fd326c8f523a Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Wed, 30 Dec 2020 08:34:08 +0000 Subject: [PATCH 1/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f874de52ed4..a595fbf254d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -159,6 +159,18 @@ 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* ## Contributing Code From 182819d143c1f069a575b64743956e8a56cfa57d Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Wed, 30 Dec 2020 08:47:30 +0000 Subject: [PATCH 2/4] Add doc formatting guidelines to CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a595fbf254d..724dc745111 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -171,6 +171,10 @@ When editing documentation, use the following standards to demonstrate the examp (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 From baaafc3b93a8d9c33c801a46fe9f44c7e7e3b61e Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Sat, 9 Jan 2021 12:24:26 +0000 Subject: [PATCH 3/4] Remove HTML
tags --- CONTRIBUTING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 724dc745111..2e12737b658 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,16 +164,15 @@ the documentation. 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.
+ 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.
+ 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 From 1143ba26ed9ef3f2d4451cac4acab3b6dcddc17b Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Fri, 22 Jan 2021 22:26:21 +0000 Subject: [PATCH 4/4] Update CONTRIBUTING.md Co-authored-by: Dongdong Tian --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index acdb967c510..ce01ef031da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -172,7 +172,7 @@ When editing documentation, use the following standards to demonstrate the examp 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* + 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".