Skip to content

Commit ce21b1a

Browse files
[3.13] gh-42237: Link to complete list of codec aliases (GH-136625) (#136627)
gh-42237: Link to complete list of codec aliases (GH-136625) Closes GH-42237 (cherry picked from commit a93d9aa) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
1 parent fac28e4 commit ce21b1a

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

Doc/library/codecs.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,8 +1061,15 @@ or with dictionaries as mapping tables. The following table lists the codecs by
10611061
name, together with a few common aliases, and the languages for which the
10621062
encoding is likely used. Neither the list of aliases nor the list of languages
10631063
is meant to be exhaustive. Notice that spelling alternatives that only differ in
1064-
case or use a hyphen instead of an underscore are also valid aliases; therefore,
1065-
e.g. ``'utf-8'`` is a valid alias for the ``'utf_8'`` codec.
1064+
case or use a hyphen instead of an underscore are also valid aliases
1065+
because they are equivalent when normalized by
1066+
:func:`~encodings.normalize_encoding`. For example, ``'utf-8'`` is a valid
1067+
alias for the ``'utf_8'`` codec.
1068+
1069+
.. note::
1070+
1071+
The below table lists the most common aliases, for a complete list
1072+
refer to the source :source:`aliases.py <Lib/encodings/aliases.py>` file.
10661073

10671074
.. impl-detail::
10681075

0 commit comments

Comments
 (0)