Fix typo and grammatical issue (#62)
Fix typo and grammatical issue in Example Guidelines
This commit is contained in:
parent
a0ca0247cd
commit
50f5219b6a
|
@ -36,7 +36,7 @@ Examples are not:
|
||||||
cloudprovider with external load balancers, etc.
|
cloudprovider with external load balancers, etc.
|
||||||
* Point to general documentation about alternatives for those
|
* Point to general documentation about alternatives for those
|
||||||
mechanisms rather than present the alternatives in each example.
|
mechanisms rather than present the alternatives in each example.
|
||||||
* Tries to balance between using using new features, and being
|
* Tries to balance between using new features, and being
|
||||||
compatible across environments.
|
compatible across environments.
|
||||||
|
|
||||||
### Throughout
|
### Throughout
|
||||||
|
@ -67,7 +67,7 @@ Examples are not:
|
||||||
* Only use the code highlighting types
|
* Only use the code highlighting types
|
||||||
[supported by Rouge](https://github.com/jneen/rouge/wiki/list-of-supported-languages-and-lexers),
|
[supported by Rouge](https://github.com/jneen/rouge/wiki/list-of-supported-languages-and-lexers),
|
||||||
as this is what GitHub Pages uses.
|
as this is what GitHub Pages uses.
|
||||||
* Commands to be copied use the `shell` syntax highlighting type, and
|
* Commands to be copied using the `shell` syntax highlighting type, and
|
||||||
do not include any kind of prompt.
|
do not include any kind of prompt.
|
||||||
* Example output is in a separate block quote to distinguish it from
|
* Example output is in a separate block quote to distinguish it from
|
||||||
the command (which doesn't have a prompt).
|
the command (which doesn't have a prompt).
|
||||||
|
|
Loading…
Reference in New Issue