]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] gh-42237: Link to complete list of codec aliases (GH-136625) (#136626)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 13 Jul 2025 13:19:23 +0000 (15:19 +0200)
committerGitHub <noreply@github.com>
Sun, 13 Jul 2025 13:19:23 +0000 (13:19 +0000)
gh-42237: Link to complete list of codec aliases (GH-136625)

Closes GH-42237
(cherry picked from commit a93d9aaf62bb2565e9eec00a2a8d06a91305127b)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Doc/library/codecs.rst

index c5dae7c8e8fd0464299780f95abda0757178ff39..1cb0e225bca043a68517b4edf43e6078dc3f97db 100644 (file)
@@ -1065,8 +1065,15 @@ or with dictionaries as mapping tables. The following table lists the codecs by
 name, together with a few common aliases, and the languages for which the
 encoding is likely used. Neither the list of aliases nor the list of languages
 is meant to be exhaustive. Notice that spelling alternatives that only differ in
-case or use a hyphen instead of an underscore are also valid aliases; therefore,
-e.g. ``'utf-8'`` is a valid alias for the ``'utf_8'`` codec.
+case or use a hyphen instead of an underscore are also valid aliases
+because they are equivalent when normalized by
+:func:`~encodings.normalize_encoding`. For example, ``'utf-8'`` is a valid
+alias for the ``'utf_8'`` codec.
+
+.. note::
+
+   The below table lists the most common aliases, for a complete list
+   refer to the source :source:`aliases.py <Lib/encodings/aliases.py>` file.
 
 On Windows, ``cpXXX`` codecs are available for all code pages.
 But only codecs listed in the following table are guarantead to exist on