sphinx-doc/sphinx

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

Open

#5 866 ouverte le 27 déc. 2018

Voir sur GitHub
 (9 commentaires) (0 réactions) (0 assignés)Python (1 985 forks)batch import
help wantedtype:docs

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

Description

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...

Guide contributeur

Direction de recherche
Consultez le guide de style de la documentation Sphinx et les schémas d'utilisation existants dans la base de code pour décider de la césure et de la capitalisation cohérentes des mots listés.
Stack technique
python
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.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90