Clarify when to mark up numeric literals

Aperta
#1,312 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia con la sezione sul markup della documentazione di devguide collegata nell’issue e confrontane la formulazione con le discussioni di PR referenziate. Aggiorna le indicazioni con regole chiare ed esempi corretti/errati di literal numerici, mostrando il completamento con una raccomandazione inequivocabile che risolva l’incoerenza citata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

needs: decision topic-documentation

The current devguide recommendations reads:

backquotes: ``text`` for code samples, variables, and literals.

Earlier, I've been corrected to use double backticks when marking up literals. Example PR remark:

Recently, I've seen other styles enforced:

Perhaps we need a clarification, possibly with good/bad examples?

Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python/devguide

Tutte le issue di python/devguide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.