Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add defaults convention to example code standards #1182

Merged
merged 3 commits into from
Apr 5, 2021
Merged

Add defaults convention to example code standards #1182

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cc2e63
Add defaults convention to example code standards
Apr 5, 2021
030d7f4
Update CONTRIBUTING.md
Apr 5, 2021
ef05660
Update CONTRIBUTING.md
Apr 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,9 @@ When editing documentation, use the following standards to demonstrate the examp
Examples: `**+l**\ *label*` results in **+l***label*, `**05m**` results in **05m**.
3. Optional arguments are placed wrapped with [ ] (square brackets).
4. Arguments that are mutually exclusive are separated with a | (bar) to denote "or".
5. Default arguments for parameters and configuration settings are placed wrapped
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
with [ ] (square brackers) with the prefix "Default is". Example: [Default is
**p**].

## Contributing Code

Expand Down