Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open python.texi and inspect its @dircategory and @direntry commands, then compare their current values with the Texinfo guidance linked in the issue. Done means the category is descriptive, the Info file name omits the .info extension, and the menu description identifies Python documentation rather than using the placeholder text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100