Circular dependency between `mapping` term `collections.abc.Mapping`
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Examinez d’abord la PR liée gh-149348, puis inspectez l’entrée du glossaire consacrée au mapping ainsi que la documentation de collections.abc.Mapping et collections.abc.MutableMapping liée dans le rapport. Mettez à jour la documentation afin que les méthodes de mapping requises soient décrites sans que les deux entrées se renvoient circulairement l’une à l’autre.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100