Skip to content

Fix comments for heapq.siftup_max() #135359

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
merged 2 commits into from
Jul 3, 2025
Merged

Conversation

yoney
Copy link
Contributor

@yoney yoney commented Jun 10, 2025

Fix the comments for the heapq module. The siftup() and siftup_max() functions are very similar, with only 1 line of difference. However, the siftup_max() still keeps the comments from the siftup().

Python version of siftup_max() has the correct comments

def _siftup_max(heap, pos):

@yoney yoney marked this pull request as ready for review June 10, 2025 20:11
@yoney yoney requested a review from rhettinger as a code owner June 10, 2025 20:11
Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

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

We generally don't accept changes to comments because they're considered cosmetic, but this one seems useful for maintenance purposes.

@kumaraditya303 kumaraditya303 merged commit 8f8bdf2 into python:main Jul 3, 2025
39 checks passed
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 3, 2025
(cherry picked from commit 8f8bdf2)

Co-authored-by: Alper <alperyoney@fb.com>
Co-authored-by: mpage <mpage@meta.com>
@bedevere-app
Copy link

bedevere-app bot commented Jul 3, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 3, 2025
(cherry picked from commit 8f8bdf2)

Co-authored-by: Alper <alperyoney@fb.com>
Co-authored-by: mpage <mpage@meta.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 3, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 3, 2025

GH-136233 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 Jul 3, 2025
kumaraditya303 pushed a commit that referenced this pull request Jul 3, 2025
Fix comments for `heapq.siftup_max` (GH-135359)
(cherry picked from commit 8f8bdf2)

Co-authored-by: Alper <alperyoney@fb.com>
Co-authored-by: mpage <mpage@meta.com>
kumaraditya303 pushed a commit that referenced this pull request Jul 3, 2025
Fix comments for `heapq.siftup_max` (GH-135359)
(cherry picked from commit 8f8bdf2)

Co-authored-by: Alper <alperyoney@fb.com>
Co-authored-by: mpage <mpage@meta.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants