python / python/cpython

`dis` module documentation lacks references to glossary

Abierto
#137,352 3 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Abre la página de documentación del módulo dis enlazada y compara sus términos del glosario con los enlaces al glosario que ya están presentes. Añade las referencias al glosario que falten para las apariciones identificadas y, después, verifica que cada aparición relevante de un término del glosario en la página enlace con su entrada del glosario.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.