Skip to content

Circular dependency between mapping term collections.abc.Mapping #149093

@Damacustas

Description

@Damacustas

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.Mapping or collections.abc.MutableMapping abstract base classes. Examples include dict, collections.defaultdict, and collections.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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions