sphinx-doc/sphinx

[DOC] Should these words use hyphens or spaces and other spelling questions

Open

#5866 aperta il 27 dic 2018

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
help wantedtype:docs

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

This is to ask for advice.

  • should "internet" be capitalized "Internet"

  • should it be "pickable" or "pickleable"?

  • should these words use an hyphen (or a space)? : autogenerates, autolinked, autonumbered, backend, backquote, dedent-ing, downtime, fallback, fallbacks, hardcoded, homepage, knowledgebase, lowlevel, markup, misdetect, misformatted, multibyte, multiline, nonbreaking, nonexisting, pagebreak, pagename, placeholder , plugin, postprocess, postprocessing, preprocesses, reindexed, reraised, standalone, subentry, testsetup, timezone, toolchain, typehint, walkthrough, website, whitespace.

This relates to #5865 and sums up all things I have not modified...

Guida contributor

Direzione di ricerca
Rivedi la guida di stile della documentazione di Sphinx e i modelli di utilizzo esistenti nel codebase per decidere la sillabazione e la capitalizzazione coerenti per le parole elencate.
Tech stack
python
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.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90