bpo-47235: Note where a typo is intentional in examples #32348
Conversation
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
added
docs
gpshead
changed the title
|
Sorry, I can't merge this PR. Reason: |
The branch was temporarily protected whilst the 3.11 alpha was going out, all ready for merge now. |
|
@gpshead any specific reason you want to backport this to 3.8? Pretty sure it's not a security issue :) |
|
Thanks @gpshead for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10. |
|
GH-32367 is a backport of this pull request to the 3.10 branch. |
|
GH-32368 is a backport of this pull request to the 3.9 branch. |
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]>
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. |
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]>
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]>
|
Thanks, good to know. I was under the impression that we wanted to strictly limit changes on the security fix branches. |
|
Great, thanks @gpshead! |
|
Yeah sometimes we do fix documentation to security branches, but I think it depends on the Release Manager :) |
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]>
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