Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
The Python documentation could be downloaded in Texinfo and Info format.
Which is great, I'm very very thankful for it.
But their is multiple problems, in the python.texi file, with the @dircategory and @direntry commands.
The @dircategory is now set to "Miscellaneous". It should be set to a more descriptive category. Like "Programming" or "Programming language" or "Python". A "Python" category could be re-used by other manuals related to Python. For example a manual for a Python framework or library.
In the @direntry command:
- The info file name, in parenthesis, should not include the
.infoextension [1] - The menu entry description should be more descriptive than "One line description of project"
[1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Listing-a-New-Info-File
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne python.texi und untersuche die Befehle @dircategory und @direntry, dann vergleiche ihre aktuellen Werte mit den in der Issue verlinkten Texinfo-Richtlinien. Erledigt ist die Aufgabe, wenn die Kategorie beschreibend ist, der Name der Info-Datei die Erweiterung .info weglässt und die Menübeschreibung die Python-Dokumentation bezeichnet, statt den Platzhaltertext zu verwenden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 35/100