python / python/cpython

Doc README omits some documentation make targets

Offen
#151,833 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Doc/README.rst lists the available documentation make targets, but it does not mention texinfo, doctest, or gettext.

These targets are defined in Doc/Makefile, so the README target list can be updated to be more complete for contributors reading the documentation build instructions.

Linked PRs
  • gh-151832

Beitragsleitfaden

Beitragsleitfaden öffnen

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

Vergleiche die Zielliste in Doc/README.rst mit den in Doc/Makefile definierten Targets, beginnend mit diesen Dateien. Aktualisiere die README, sodass texinfo, doctest und gettext erwähnt werden, und überprüfe anschließend, dass die dokumentierte Liste mit den verfügbaren Targets übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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