suzanne.soy/qubes-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add guideline on syntactically distinguishing variables in commands

Browse Source
This commit is contained in:
Andrew David Wong 2020-11-23 07:08:35 -08:00
parent cf9da2f7d7
commit 3df2ffa6f6
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
developer/general/doc-guidelines.md
View File

@ -241,6 +241,19 @@ Style Guidelines
* Familiarize yourself with the terms defined in the [glossary]. Use these * Familiarize yourself with the terms defined in the [glossary]. Use these
terms consistently and accurately throughout your writing. terms consistently and accurately throughout your writing.
* Syntactically distinguish variables in commands.
For example, this is ambiguous:
$ qvm-run --dispvm=dvm-template --service qubes.StartApp+xterm
It should instead be:
$ qvm-run --dispvm=<DVM_TEMPLATE> --service qubes.StartApp+xterm
Note that we syntactically distinguish variables in three ways:
1. Surrounding them in angled brackets (`< >`)
2. Using underscores (`_`) between words
3. Using all capital letters
Markdown Conventions Markdown Conventions