Skip to content

gh-106318: Add example for str.encode() #134520

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

gh-106318: Add example for str.encode() #134520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1817,9 +1817,15 @@ expression support in the :mod:`re` module).
See :ref:`error-handlers` for details.

For performance reasons, the value of *errors* is not checked for validity
unless an encoding error actually occurs,
:ref:`devmode` is enabled
or a :ref:`debug build <debug-build>` is used.
unless an encoding error actually occurs, :ref:`devmode` is enabled or a :ref:`debug build <debug-build>` is used.
Copy link
Member

Choose a reason for hiding this comment

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

Let's keep the original whitespace for this unchanged text.

We generally leave unchanged lines, and in any case try and limit to 80 chars.

https://devguide.python.org/documentation/markup/#use-of-whitespace

Suggested change
unless an encoding error actually occurs, :ref:`devmode` is enabled or a :ref:`debug build <debug-build>` is used.
unless an encoding error actually occurs,
:ref:`devmode` is enabled
or a :ref:`debug build <debug-build>` is used.

For example::

>>> encoded_str_to_byte = 'Python'.encode()
>>> type(encoded_str_to_byte)
<class 'bytes'>
>>> encoded_str_to_byte
Comment on lines +1823 to +1826
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
>>> encoded_str_to_byte = 'Python'.encode()
>>> type(encoded_str_to_byte)
<class 'bytes'>
>>> encoded_str_to_byte
>>> encoded_str_to_bytes = 'Python'.encode()
>>> type(encoded_str_to_bytes)
<class 'bytes'>
>>> encoded_str_to_bytes

b'Python'


.. versionchanged:: 3.1
Added support for keyword arguments.
Expand Down
Loading