[New-bugs-announce] [issue26847] filter docs unclear wording

[Luke]

New submission from Luke:

The current docs for both filter and itertools.filterfalse use the following wording (emphasis added):

all elements that are false are removed
returns the items that are false
This could be confusing for a new Python programmer, because the actual behaviour is that elements are equality-compared, not identity-compared.

Suggested wording: "are equal to False"

https://docs.python.org/3.5/library/functions.html#filter
https://docs.python.org/3.5/library/itertools.html#itertools.filterfalse

----------
assignee: docs at python
components: Documentation
messages: 264206
nosy: docs at python, unfamiliarplace
priority: normal
severity: normal
status: open
title: filter docs unclear wording
type: enhancement
versions: Python 3.5

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