python / python/cpython

Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands

Aperta
#130,517 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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 .info extension [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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Apri python.texi e ispeziona i suoi comandi @dircategory e @direntry, quindi confronta i loro valori attuali con le indicazioni di Texinfo collegate nell’issue. Il lavoro è completato quando la categoria è descrittiva, il nome del file Info omette l’estensione .info e la descrizione del menu identifica la documentazione Python invece di usare il testo segnaposto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.