]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-42237: Link to complete list of codec aliases (#136625)
authorStan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Sun, 13 Jul 2025 13:12:46 +0000 (15:12 +0200)
committerGitHub <noreply@github.com>
Sun, 13 Jul 2025 13:12:46 +0000 (13:12 +0000)
Closes #42237

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