-
-
Notifications
You must be signed in to change notification settings - Fork 34.1k
gh-62480: Remove first-person language from heapq documentation #144665
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
base: main
Are you sure you want to change the base?
Conversation
StanFromIreland
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes make little sense, I'm afraid.
Doc/library/heapq.rst
Outdated
|
|
||
| In a word, heaps are useful memory structures to know. I use them in a few | ||
| applications, and I think it is good to keep a 'heap' module around. :-) | ||
| In a word, heaps are useful memory structures to know. They are used in a number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn’t really make much sense now, a thought, maybe we could make this a quote?
Doc/library/heapq.rst
Outdated
| execution, they are scheduled into the future, so they can easily go into the | ||
| heap. So, a heap is a good structure for implementing schedulers (this is what | ||
| I used for my MIDI sequencer :-). | ||
| was used for the MIDI sequencer in the standard library). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What "MIDI sequencer in the standard library"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the MIDI sequencer reference entirely?
|
Please do not use the Update Branch button unless necessary (e.g. fixing conflicts, jogging the CI, or very old PRs) as it uses valuable resources. For more information see the devguide. |
Address review feedback: drop the remainder of the sentence after "heaps are useful memory structures to know" to avoid awkward impersonal rewording of the original first-person text.
Address review feedback: the parenthetical claimed a MIDI sequencer exists in the standard library, which it does not. Drop the reference and keep the sentence concise.
Replace first-person pronouns ("I", "my") with impersonal alternatives in the heapq module Theory section. Also removed "Believe me" from the footnote.
Relates to #62480.
📚 Documentation preview 📚: https://cpython-previews--144665.org.readthedocs.build/