Circular dependency between `mapping` term `collections.abc.Mapping`
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
Documentation
The mapping (1) glossary term is defined as
A container object that supports arbitrary key lookups and implements the methods specified in the
collections.abc.Mappingorcollections.abc.MutableMappingabstract base classes. Examples includedict,collections.defaultdict, andcollections.Counter.
Whereas for example collections.abc.Mapping(2) and collections.abc.MutableMapping(2) have the documentation:
ABCs for read-only and mutable mappings.
I expected either the documentation on a mapping or the documentation on the ABC's to describe or link to what methods a (mutable) mapping implements. Now they refer to each other in a circle for the actual specification of what methods are required.
1: https://docs.python.org/3/glossary.html#term-mapping
2: https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping
Linked PRs
- gh-149348
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Revisa primero el PR vinculado gh-149348 y, después, inspecciona la entrada del glosario sobre mapping y la documentación de collections.abc.Mapping y collections.abc.MutableMapping enlazada en el informe. Actualiza la documentación para que se describan los métodos de mapping requeridos sin que las dos entradas hagan referencia circular entre sí.
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