Circular dependency between `mapping` term `collections.abc.Mapping`
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Esamina prima la PR collegata gh-149348, quindi analizza la voce del glossario relativa al mapping e la documentazione di collections.abc.Mapping e collections.abc.MutableMapping collegata nel report. Aggiorna la documentazione in modo che i metodi di mapping richiesti siano descritti senza che le due voci rimandino circolarmente l’una all’altra.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100