python / python/mypy

[docs] merge error code lists

Abierto
#20,077 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

documentation
Lenguaje dominante
Python
Estrellas
20.6k
Forks
3.3k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Documentation

error_code_list.rst and error_code_list2.rst should be merged. The main result of having two pages is that half the time I end up checking the wrong page if I don't know beforehand whether the code is enabled or disabled by default. Instead, that enablement information should be documented in each entry (possibly also whether or not it's enabled by default in strict mode, ideally).

To elaborate a little, perhaps unnecessarily, I assume there are three types of interactions we could be designing the error codes page(s) for:

  1. People reading the documentation cover-to-cover, or similar. Having the error codes split up like this is probably useful to them, but I doubt this is a common interaction.
  2. People searching for the error codes using a search engine. These people probably get to the right page either way. While this is useful, usually I don't do this and I try to go directly to the error page, because a general search will sometimes give you unhelpful pages that just happened to mention the code
  3. People already on the page, using ctrl-f to cross-reference or find entries. I think this is a useful activity and it's greatly stymied by having them split apart on different pages.

While we're at it, the current error_codes.rst could just be a preamble, and all three pages could be merged into one.

Ideally, preservative redirects would be made. As in any documentation refactor.

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

Empieza leyendo error_code_list.rst, error_code_list2.rst y error_codes.rst para entender su estructura actual y cómo describen los detalles de habilitación las entradas de códigos de error. Planifica una única página combinada con detalles de habilitación para cada entrada, incluido el estado del modo estricto cuando esté disponible, y conserva las redirecciones desde las páginas existentes. Se considera terminado cuando las tres páginas se hayan combinado sin perder información y las URL antiguas redirijan correctamente.

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
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.