python / python/cpython

`dis` module documentation lacks references to glossary

Offen
#137,352 3 Kommentare 4 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

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

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

Öffne die verlinkte Dokumentationsseite des dis-Moduls und vergleiche ihre Glossarbegriffe mit den bereits vorhandenen Glossarlinks. Füge für die identifizierten Vorkommen fehlende Glossarreferenzen hinzu und überprüfe anschließend, dass jedes relevante Vorkommen eines Glossarbegriffs auf der Seite mit seinem Glossareintrag verlinkt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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