`dis` module documentation lacks references to glossary
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
On dis page some terms do not have references to glossary. For example, "borrowed reference" is mentioned and listed in glossary, but no mention contains an actual link to glossary.
Also, many terms have reference only in some places, like "generator", which has only 2 links out of ~20 occurrences on the page.
My thoughts are that we should add a link for every glossary term occurrence (at least on this page). If you agree with proposed changes, I'd be happy to make a PR. :)
Linked PRs
- gh-137787
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 the linked dis module documentation page and compare its glossary terms with the glossary links already present. Add missing glossary references for the identified occurrences, then verify that every relevant glossary term occurrence on the page links to its glossary entry.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100