diff options
| author | Chris Couzens <ccouzens@gmail.com> | 2021-02-05 17:28:04 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-05 17:28:04 +0000 |
| commit | 7af4f21daf3f23365ada6899c24cdbfac741b841 (patch) | |
| tree | 889dd9051104c97c3d9cb73b8619d2100583406e | |
| parent | eb549af38cde9d04c8aa6b3bf04679d6dd5ac529 (diff) | |
API conventions: escape back-quotes when visible
> When referencing another field name, indicate the name in back-quotes. Example: "must be greater than `request`".
In this sentence, we're meant to see "request" surrounded by back-quotes.
In markdown, backticks (back-quotes) are used to create a code section, and thus aren't shown. By escaping them, they are shown to the user.
| -rw-r--r-- | contributors/devel/sig-architecture/api-conventions.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/contributors/devel/sig-architecture/api-conventions.md b/contributors/devel/sig-architecture/api-conventions.md index cd18e88e..6efdcb53 100644 --- a/contributors/devel/sig-architecture/api-conventions.md +++ b/contributors/devel/sig-architecture/api-conventions.md @@ -1428,7 +1428,7 @@ specified". * When referencing a literal string value, indicate the literal in single-quotes. Example: "must not contain '..'". * When referencing another field name, indicate the name in back-quotes. -Example: "must be greater than `request`". +Example: "must be greater than \`request\`". * When specifying inequalities, use words rather than symbols. Examples: "must be less than 256", "must be greater than or equal to 0". Do not use words like "larger than", "bigger than", "more than", "higher than", etc. |