Chiebot-Mirror
/
data-plane-api
mirror of https://github.com/envoyproxy/data-plane-api.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Improve style for inline literals and update contrib guidance (#16194)

Browse Source 
Signed-off-by: Ryan Northey <ryan@synca.io>

Mirrored from https://github.com/envoyproxy/envoy @ eb18d71972e1f8af714d7843eb206108aad153c7
pull/624/head
data-plane-api(Azure Pipelines) 4 years ago
parent cb3ff03db2
commit 418210329c
1 changed files with 1 additions and 2 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      CONTRIBUTING.md

3
CONTRIBUTING.md
Unescape View File

@ -72,7 +72,6 @@ The following are some general guidelines around documentation.
// [#comment:TODO(mattklein123): Do something cooler]
string foo_field = 3;
```
* Prefer *italics* for emphasis as `backtick` emphasis is somewhat jarring in our Sphinx theme.
* Please use *italics* (enclosed in asterisks `*emphasized word*`) for emphasis and `inline literals` for code quotation (enclosed in *double* backticks ` ``code`` `).
* All documentation is expected to use proper English grammar with proper punctuation. If you are
not a fluent English speaker please let us know and we will help out.

Write Preview
Loading…
Cancel
Save