bpo-37751: Update codecs.register() doc. (GH-25643)

This commit is contained in:
Inada Naoki 2021-04-28 09:37:02 +09:00 committed by GitHub
parent a09766deab
commit 5c84bb506a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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.
.. function:: unregister(search_function)