Skip to content

Commit 7af4f21

Browse files
authored
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.
1 parent eb549af commit 7af4f21

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

contributors/devel/sig-architecture/api-conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1428,7 +1428,7 @@ specified".
14281428
* When referencing a literal string value, indicate the literal in
14291429
single-quotes. Example: "must not contain '..'".
14301430
* When referencing another field name, indicate the name in back-quotes.
1431-
Example: "must be greater than `request`".
1431+
Example: "must be greater than \`request\`".
14321432
* When specifying inequalities, use words rather than symbols. Examples: "must
14331433
be less than 256", "must be greater than or equal to 0". Do not use words
14341434
like "larger than", "bigger than", "more than", "higher than", etc.

0 commit comments

Comments
 (0)