envoyproxy/envoy

Fix inline literals in the docs

Open

#19.634 aperta il 20 gen 2022

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docshelp wantedlintingtech debt

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Cerca i pattern di letterali inline con singolo backtick (`...`) nei file di documentazione e sostituiscili con double backtick (``...``). Assicurati la coerenza in tutto il codebase.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
reStructuredText (RST)
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85