Skip to content

bpo-32118: Simplify docs for sequence comparison #15450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 24, 2019
Merged

bpo-32118: Simplify docs for sequence comparison #15450

merged 2 commits into from
Aug 24, 2019

Conversation

rhettinger
Copy link
Contributor

@rhettinger rhettinger commented Aug 24, 2019 •
edited by bedevere-bot
Loading

This section had become a mess, focusing on a pathological case and not clearly specifying the essential behavior: "sequences bypass equality checks for identical objects".

NaN behavior is already covered elsewhere.

https://bugs.python.org/issue32118

@rhettinger rhettinger added docs Documentation in the Doc dir needs backport to 3.8 labels Aug 24, 2019
@rhettinger rhettinger requested a review from terryjreedy August 24, 2019 06:27
terryjreedy
terryjreedy approved these changes Aug 24, 2019
View reviewed changes
Copy link
Member

@terryjreedy terryjreedy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. It add something useful about singletons. The condensed replacement is better than what I vaguely suggested. I agree that the second sentence gives the essential what -- what people need to know about what Python does to write successful code.

I considered whether 'internal invariants' should be expanded. The main one is that an object put into a sequence should be seen as in the sequence. But anything about that really belongs in discussion of 'in' and '__contains__'. I decided that the 3rd sentence is sufficient justification as is for why Python makes the stated assumption.

@rhettinger rhettinger merged commit edd2112 into python:master Aug 24, 2019
@rhettinger rhettinger deleted the seq_comp branch August 24, 2019 17:43
@miss-islington
Copy link
Contributor

Thanks @rhettinger for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 24, 2019
@rhettinger @miss-islington
bpo-32118: Simplify docs for sequence comparison (pythonGH-15450)
dc9bb4d 
(cherry picked from commit edd2112)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
@bedevere-bot
Copy link

GH-15466 is a backport of this pull request to the 3.8 branch.

rhettinger added a commit that referenced this pull request Aug 24, 2019
@miss-islington @rhettinger
bpo-32118: Simplify docs for sequence comparison (GH-15450) (#15466)
0ad8568 
(cherry picked from commit edd2112)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@rhettinger @lisroach
bpo-32118: Simplify docs for sequence comparison (pythonGH-15450)
a2f3587
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@rhettinger @DinoV
bpo-32118: Simplify docs for sequence comparison (pythonGH-15450)
6375e26
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@rhettinger @websurfer5
bpo-32118: Simplify docs for sequence comparison (pythonGH-15450)
2839f65
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@terryjreedy terryjreedy terryjreedy approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rhettinger @miss-islington @bedevere-bot @terryjreedy @the-knights-who-say-ni