Skip to content
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

gh-97725: Fix documentation for the default file of Task.print_stack #101652

Merged
merged 1 commit into from
Feb 7, 2023

Conversation

arhadthedev
Copy link
Member

@arhadthedev arhadthedev commented Feb 7, 2023

Alternative to gh-97726. Addresses @gvanrossum's objection:

But do we want to fix the code to match the docs? In cases like this, where the docs and the code have always disagreed (or for many releases), we tend to prefer to fix the docs to match the code, since "fixing" the code may actually break apps that were expecting the observed behavior.

Also, print_* kind of suggests that it does the same thing as print(). More indication to me that the docs were just wrong (it happens :-).

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thanks!

@gvanrossum
Copy link
Member

I guess I have to merge it too. :-)

@kumaraditya303 kumaraditya303 merged commit f87f6e2 into python:main Feb 7, 2023
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry @arhadthedev and @kumaraditya303, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker f87f6e23964d7a4c38b655089cda65538a24ec36 3.11

@arhadthedev arhadthedev deleted the doc/task-printstack branch February 7, 2023 18:04
arhadthedev added a commit to arhadthedev/cpython that referenced this pull request Feb 7, 2023
arhadthedev added a commit to arhadthedev/cpython that referenced this pull request Feb 7, 2023
@bedevere-bot
Copy link

GH-101653 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 7, 2023
@bedevere-bot
Copy link

GH-101654 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 7, 2023
ambv pushed a commit that referenced this pull request Feb 8, 2023
ambv pushed a commit that referenced this pull request Feb 8, 2023
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 topic-asyncio
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants