gh-99991: improve docs on str.encode and bytes.decode #100198
Conversation
|
| Name | Link |
|---|---|
| 86c44a4 | |
| https://app.netlify.com/sites/python-cpython-preview/deploys/63977a667613200008c22058 | |
| https://deploy-preview-100198--python-cpython-preview.netlify.app | |
Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
|
All commit authors signed the Contributor License Agreement. |
AlexWaygood
changed the title
kumaraditya303
changed the title
Thanks. I've added some suggestions to fix grammar errors, better implement the original feedback in the issue, follow our conventions and the Diataxis principles, and clarify and improve the phrasing and markup, as well as a couple comments I couldn't leave as suggestions that you'll need to implement manually (or I can implement as a commit on your branch, if you prefer).
Just FYI, in case you're unfamiliar—you can directly apply some or all of my suggestions by going to the Files changed tab, clicking Add to batch on each suggestion, then clicking Commit with a descriptive message.
Doc/library/stdtypes.rst
Outdated
| By default, the *errors* argument is not checked for best performances, but | ||
| only used at the first encoding error. Enable the :ref:`Python Development |
There was a problem hiding this comment.
I was not able to actually make this as suggestion, but this implements the revision from the issue, while still including the key details from the previous version.
For performance reasons, the value of *errors* is not checked for validity
unless an encoding error actually occurs,
:ref:`Python Development Mode <devmode>` is enabled
or a :ref:`debug build <debug-build>` is used.
Doc/library/stdtypes.rst
Outdated
| By default, the *errors* argument is not checked for best performances, but | ||
| only used at the first decoding error. Enable the :ref:`Python Development |
There was a problem hiding this comment.
I was not able to actually make this as suggestion, but this implements the revision from the issue, while still including the key details from the previous version.
For performance reasons, the value of *errors* is not checked for validity
unless a decoding error actually occurs,
:ref:`Python Development Mode <devmode>` is enabled
or a :ref:`debug build <debug-build>` is used.
…s.decode more clear Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
|
Thanks for the suggestions and comments @CAM-Gerlach. And yes, I'll prefer you implement a commit on my branch. |
|
Done, thanks. I also made a few small refinements to the text of the |
|
Thanks @bizzyvinci for the PR, and @JelleZijlstra for merging it |
|
GH-100382 is a backport of this pull request to the 3.11 branch. |
|
GH-100383 is a backport of this pull request to the 3.10 branch. |
Update str.encode and byte.decode docs.