[New-bugs-announce] [issue24406] "Bulit-in Types" documentation doesn't explain how dictionaries are compared for equality

[Gareth Rees]

New submission from Gareth Rees:

The "Built-in Types" section of the library documentation does not explain how two dictionaries are compared for equality.

The place where this is documented is under "Comparisons" in the Language Reference:

> Mappings (dictionaries) compare equal if and only if they have the same (key, value) pairs.

but it is not obvious from the section on dictionaries in "Built-in Types" that this is where to look.

(Contrast with the situation for sequences and sets, where "Built-in Types" does explain how these objects are compared for equality.)

I suggest that the "Built-in Types" section should explain how two dictionaries are tested for equality.

----------
assignee: docs at python
components: Documentation
files: dict-equality.patch
keywords: patch
messages: 244998
nosy: Gareth.Rees, docs at python
priority: normal
severity: normal
status: open
title: "Bulit-in Types" documentation doesn't explain how dictionaries are compared for equality
type: enhancement
Added file: http://bugs.python.org/file39658/dict-equality.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue24406>
_______________________________________