GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-47235: Note where a typo is intentional in examples by gpshead · Pull Request #32348 · python/cpython

Conversation

@gpshead

@gpshead gpshead commented Apr 6, 2022 •
edited by miss-islington
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text. Hopefully a comment
on the line itself makes it more obvious?

Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code. But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.

https://bugs.python.org/issue47235

Automerge-Triggered-By: GH:gpshead

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@gpshead
bpo-47235: Note where a typo is intentional in code.
298e3ba 
People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text.  Hopefully a comment
on the line itself makes it more obvious?

Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code.  But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.
@gpshead gpshead added docs Documentation in the Doc dir skip news needs backport to 3.8 labels Apr 6, 2022
@gpshead gpshead self-assigned this Apr 6, 2022
@bedevere-bot bedevere-bot added the awaiting core review label Apr 6, 2022
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Apr 6, 2022
@gpshead gpshead changed the title bpo-47235: Note where a typo is intentional in code. bpo-47235: Note where a typo is intentional in examples Apr 6, 2022
@gpshead
gpshead requested a review from Mariatta April 6, 2022 00:31
JelleZijlstra
JelleZijlstra approved these changes Apr 6, 2022
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Apr 6, 2022
@gpshead gpshead added the 🤖 automerge label Apr 6, 2022
@miss-islington

miss-islington commented Apr 6, 2022

Copy link
Copy Markdown
Contributor

Sorry, I can't merge this PR. Reason: You're not authorized to push to this branch. Visit https://docs.github.com/articles/about-protected-branches/ for more information..
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@hugovk

hugovk commented Apr 6, 2022

Copy link
Copy Markdown
Member

Sorry, I can't merge this PR. Reason: You're not authorized to push to this branch. Visit https://docs.github.com/articles/about-protected-branches/ for more information..

The branch was temporarily protected whilst the 3.11 alpha was going out, all ready for merge now.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Fidget-Spinner
Fidget-Spinner approved these changes Apr 6, 2022
View reviewed changes

@Fidget-Spinner Fidget-Spinner left a comment

Copy link
Copy Markdown
Member

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.

Maybe this might re-trigger the bot.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@JelleZijlstra

JelleZijlstra commented Apr 6, 2022

Copy link
Copy Markdown
Member

@gpshead any specific reason you want to backport this to 3.8? Pretty sure it's not a security issue :)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@gpshead gpshead removed the needs backport to 3.8 label Apr 6, 2022
@gpshead
gpshead merged commit ac1fb07 into python:main Apr 6, 2022
@miss-islington

miss-islington commented Apr 6, 2022

Copy link
Copy Markdown
Contributor

Thanks @gpshead for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the awaiting merge label Apr 6, 2022
@gpshead
gpshead deleted the assret-docs branch April 6, 2022 15:07
@bedevere-bot bedevere-bot removed the needs backport to 3.10 label Apr 6, 2022
@bedevere-bot

bedevere-bot commented Apr 6, 2022

Copy link
Copy Markdown

GH-32367 is a backport of this pull request to the 3.10 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot

bedevere-bot commented Apr 6, 2022

Copy link
Copy Markdown

GH-32368 is a backport of this pull request to the 3.9 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the needs backport to 3.9 label Apr 6, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 6, 2022
@gpshead @miss-islington
bpo-47235: Note where a typo is intentional in code. (pythonGH-32348)
1040bb9 
People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text.  Hopefully a comment
on the line itself makes it more obvious?

Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code.  But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.
(cherry picked from commit ac1fb07)

Co-authored-by: Gregory P. Smith <[email protected]>
@gpshead

gpshead commented Apr 6, 2022

Copy link
Copy Markdown
Member Author

any specific reason you want to backport this to 3.8? Pretty sure it's not a security issue :)

I tend to backport doc fixes as far back as they'll go if the patch applies cleanly as people to reference and read older versioned docs. not really important for this one. 3.8 removed.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
miss-islington added a commit that referenced this pull request Apr 6, 2022
@miss-islington @gpshead
bpo-47235: Note where a typo is intentional in code. (GH-32348)
3856b49 
People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text.  Hopefully a comment
on the line itself makes it more obvious?

Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code.  But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.
(cherry picked from commit ac1fb07)

Co-authored-by: Gregory P. Smith <[email protected]>
miss-islington added a commit that referenced this pull request Apr 6, 2022
@miss-islington @gpshead
bpo-47235: Note where a typo is intentional in code. (GH-32348)
770780e 
People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text.  Hopefully a comment
on the line itself makes it more obvious?

Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code.  But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.
(cherry picked from commit ac1fb07)

Co-authored-by: Gregory P. Smith <[email protected]>
@JelleZijlstra

JelleZijlstra commented Apr 6, 2022

Copy link
Copy Markdown
Member

Thanks, good to know. I was under the impression that we wanted to strictly limit changes on the security fix branches.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta

Mariatta commented Apr 6, 2022

Copy link
Copy Markdown
Member

Great, thanks @gpshead!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta

Mariatta commented Apr 6, 2022

Copy link
Copy Markdown
Member

Yeah sometimes we do fix documentation to security branches, but I think it depends on the Release Manager :)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AlexWaygood AlexWaygood mentioned this pull request Apr 19, 2022
Two (possible) improvements at dataclasses.rst #91687
Closed
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islington @gpshead @hello-adam
bpo-47235: Note where a typo is intentional in code. (pythonGH-32348)
f848e01 
People keep popping up reporting these as typos in the docs despite
being described as typos in the surrounding text.  Hopefully a comment
on the line itself makes it more obvious?

Arguably some of the typo examples are not using the "right" typo as the
"assret" one in particular is now detected by default due to how common
it was in actual code.  But I don't want to to typo chasing by changing
these examples to be other not yet auto-detected typos as they still
illustrate the point well enough.
(cherry picked from commit ac1fb07)

Co-authored-by: Gregory P. Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes
@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes
@Mariatta Mariatta Awaiting requested review from Mariatta

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@gpshead gpshead

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.

Uh oh!

There was an error while loading. Please reload this page.

8 participants

@gpshead @miss-islington @hugovk @JelleZijlstra @bedevere-bot @Mariatta @Fidget-Spinner @the-knights-who-say-ni
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.