python / python/docs-community

Changing docs for trivial issues

Offen
#50 28 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

doc:styleguide
Vorherrschende Sprache
Makefile
Sterne
55
Forks
26
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

There's this open issue right now on British vs American spelling:

https://github.com/python/cpython/issues/82221

In the past, there's been some merged PRs on similar smallish consistency/grammar issues:

https://github.com/python/cpython/pull/2787
https://github.com/python/cpython/pull/25985

However, there are also these other comments that seem to resist against trivial changes:

https://github.com/python/cpython/issues/58372#issuecomment-1093572060
https://github.com/python/cpython/issues/62480#issuecomment-1093619748

The sense that I'm getting is that trivial / minor grammatical / consistency issues are generally not considered if it's either unreported, too large such that it'll take more core dev reviewing time than it's worth in improvement, or touches on somewhat historical docs. Would this be an accurate summary on whether to consider committing small changes?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Prüfe das verlinkte Issue und die Pull Requests zu britischer/amerikanischer Schreibweise sowie kleinen Änderungen an Grammatik oder Konsistenz und vergleiche anschließend die ablehnenden Kommentare in den Issues 58372 und 62480. Die Arbeit ist abgeschlossen, wenn die Position des Projekts zur Annahme trivialer Dokumentationsänderungen für Contributors klar zusammengefasst ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.