envoyproxy/envoy

Fix inline literals in the docs

Open

#19,634 opened on 2022年1月20日

GitHub で見る
 (7 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wantedlintingtech debt

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (平均マージ 8d) (30d で 378 merged PRs)

説明

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

コントリビューターガイド