Skip to content

gh-133361: move the explanation of dict equal before its use #133424

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.

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

Merged

Conversation

Yzi-Li
Copy link
Contributor

@Yzi-Li Yzi-Li commented May 5, 2025

Move the explanation of dict's == operator before its use.


📚 Documentation preview 📚: https://cpython-previews--133424.org.readthedocs.build/

@StanFromIreland
Copy link
Contributor

Requesting @terryjreedy , is this what you wanted?

@Yzi-Li
Copy link
Contributor Author

Yzi-Li commented May 6, 2025

Yes, thanks!

@terryjreedy
Copy link
Member

Not quite. I meant to move 5011-3, "Dictionaries compare equal ... TypeError." to the beginning of 4826, "To illustrate,", with the latter part of the same paragraph. I think the latter should be expanded to "To illustrate dict creation and equality,".

I think moving the order text and example, as you did, is also good. I will look at the preview after the additional change.

@terryjreedy terryjreedy self-assigned this May 6, 2025
@terryjreedy terryjreedy added the needs backport to 3.13 bugs and security fixes label May 6, 2025
@Yzi-Li
Copy link
Contributor Author

Yzi-Li commented May 6, 2025

@terryjreedy Hi! I have seen your suggestions. Could you please review again? Thanks!

@terryjreedy
Copy link
Member

Please undo 0600d30 - it is not what I said. Please carefully reread what I wrote, which was to move the paragraph on lines 5011 to 5013 that begin with "Dictionaries compare equal" and ends with "`TypeError`."

@Yzi-Li
Copy link
Contributor Author

Yzi-Li commented May 7, 2025

Sorry, I did not do it as you said. I reread what you wrote and changed it.

@terryjreedy terryjreedy added the needs backport to 3.14 bugs and security fixes label May 7, 2025
@terryjreedy
Copy link
Member

Lines are not allowed to have trailing spaces. It seems that github suggestion editor autoindents when one hits 'Return'. So one should put the cursor at the beginning of the line that should be after the blank, instead of the end of the (indented) line before the blank.

@terryjreedy terryjreedy merged commit 61ac88c into python:main May 7, 2025
24 checks passed
@miss-islington-app
Copy link

Thanks @Yzi-Li for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs May 7, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 7, 2025
…ythonGH-133424)

Also move up the explanation of insertion order preservation.  Both paragraphs seemed out of place down where they were.
---------
(cherry picked from commit 61ac88c)

Co-authored-by: Yongzi Li <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 7, 2025
…ythonGH-133424)

Also move up the explanation of insertion order preservation.  Both paragraphs seemed out of place down where they were.
---------
(cherry picked from commit 61ac88c)

Co-authored-by: Yongzi Li <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented May 7, 2025

GH-133620 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label May 7, 2025
@bedevere-app
Copy link

bedevere-app bot commented May 7, 2025

GH-133621 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label May 7, 2025
terryjreedy added a commit that referenced this pull request May 7, 2025
…H-133424) (#133620)

gh-133361: move the explanation of dict equal before its use (GH-133424)

Also move up the explanation of insertion order preservation.  Both paragraphs seemed out of place down where they were.
---------
(cherry picked from commit 61ac88c)

Co-authored-by: Yongzi Li <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
terryjreedy added a commit that referenced this pull request May 7, 2025
…H-133424) (#133621)

gh-133361: move the explanation of dict equal before its use (GH-133424)

Also move up the explanation of insertion order preservation.  Both paragraphs seemed out of place down where they were.
---------
(cherry picked from commit 61ac88c)

Co-authored-by: Yongzi Li <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
@Yzi-Li
Copy link
Contributor Author

Yzi-Li commented May 8, 2025

Thank you so much with your help!

@Yzi-Li Yzi-Li deleted the move-dict-equal-explanation-before-use branch May 8, 2025 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants