envoyproxy/envoy

Fix inline literals in the docs

Open

#19 634 ouverte le 20 janv. 2022

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)C++ (5 373 forks)batch import
area/docshelp wantedlintingtech debt

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Recherchez les motifs de litteraux inline avec un seul backtick (`...`) dans les fichiers de documentation et remplacez les par des backticks doubles (``...``). Assurez la coherence dans l'ensemble du codebase.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
reStructuredText (RST)
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85