Skip to content

[3.9] bpo-37751: Update codecs.register() doc. (GH-25643) #25677

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

Merged
merged 1 commit into from
Apr 28, 2021
Merged

[3.9] bpo-37751: Update codecs.register() doc. (GH-25643) #25677

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

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions Doc/library/codecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,13 @@ function:
.. function:: register(search_function)

Register a codec search function. Search functions are expected to take one
argument, being the encoding name in all lower case letters, and return a
:class:`CodecInfo` object. In case a search function cannot find
a given encoding, it should return ``None``.
argument, being the encoding name in all lower case letters with hyphens
and spaces converted to underscores, and return a :class:`CodecInfo` object.
In case a search function cannot find a given encoding, it should return
``None``.

.. versionchanged:: 3.9
Hyphens and spaces are converted to underscore.

.. note::

Expand Down