envoyproxy/envoy

Fix inline literals in the docs

Open

#19.634 aberto em 20 de jan. de 2022

Ver no GitHub
 (7 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/docshelp wantedlintingtech debt

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Pesquise padrões de literais inline com crase simples (`...`) nos arquivos de documentação e substitua por crases duplas (``...``). Garanta consistência em toda a base de código.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
reStructuredText (RST)
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85