Skip to content

Commit c1b20e5

Browse files
Meghan Jonesseisman
andauthored
Add defaults convention to example code standards (#1182)
* Add defaults convention to example code standards Co-authored-by: Dongdong Tian <[email protected]>
1 parent bee02c7 commit c1b20e5

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,11 @@ When editing documentation, use the following standards to demonstrate the examp
187187
(two asterisks) on both sides. The argument description should be in *italicized*
188188
with \* (single asterisk) on both sides.
189189
Examples: `**+l**\ *label*` results in **+l***label*, `**05m**` results in **05m**.
190-
3. Optional arguments are placed wrapped with [ ] (square brackets).
190+
3. Optional arguments are wrapped with [ ] (square brackets).
191191
4. Arguments that are mutually exclusive are separated with a | (bar) to denote "or".
192+
5. Default arguments for parameters and configuration settings are wrapped
193+
with [ ] (square brackers) with the prefix "Default is". Example: [Default is
194+
**p**].
192195

193196
## Contributing Code
194197

0 commit comments

Comments
 (0)