envoyproxy/envoy

Fix inline literals in the docs

Open

#19.634 geöffnet am 20. Jan. 2022

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docshelp wantedlintingtech debt

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

description

historically it was the policy to use single backticks for inline-literals in the docs, which has the effect of making them italics.

the correct rst spec for these is to use double-backticks.

i have been cleaning these up in docs i have worked on or in prs i have reviewed but there are still a lot of places that have italicized inline-literals

we can probably break this up into fixing different parts of the site - ie api, docs, etc

ideally, once this is fixed we would want it to stay fixed - see #19633 for further discussion of this

Contributor Guide