Skip to content

encodings module is not documented #136162

New issue
New issue
Closed
Closed
encodings module is not documented#136162
Labels
docsDocumentation in the Doc dirstdlibPython modules in the Lib dirtype-featureA feature request or enhancement
@sobolevn

Description

@sobolevn
sobolevn
opened on Jul 1, 2025

Feature or enhancement

encodings contains several public and documented (at the module level) functions:

cpython/Lib/encodings/__init__.py

Lines 1 to 29 in 23caccf

""" Standard "encodings" Package
Standard Python encoding modules are stored in this package
directory.
Codec modules must have names corresponding to normalized encoding
names as defined in the normalize_encoding() function below, e.g.
'utf-8' must be implemented by the module 'utf_8.py'.
Each codec module must export the following interface:
* getregentry() -> codecs.CodecInfo object
The getregentry() API must return a CodecInfo object with encoder, decoder,
incrementalencoder, incrementaldecoder, streamwriter and streamreader
attributes which adhere to the Python Codec Interface Standard.
In addition, a module may optionally also define the following
APIs which are then used by the package's codec search function:
* getaliases() -> sequence of encoding name strings to use as aliases
Alias names returned by getaliases() must be normalized encoding
names as defined by normalize_encoding().
Written by Marc-Andre Lemburg (mal@lemburg.com).
(c) Copyright CNRI, All Rights Reserved. NO WARRANTY.
"""#"

But, only its submodules are documented in codecs.rst:

cpython/Doc/library/codecs.rst

Lines 1487 to 1491 in 23caccf

:mod:`encodings.idna` --- Internationalized Domain Names in Applications
------------------------------------------------------------------------
.. module:: encodings.idna
:synopsis: Internationalized Domain Names implementation

Should we add encodings itself to the docs?

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirstdlibPython modules in the Lib dirtype-featureA feature request or enhancement

    Projects

    Codecs and encodings issues

    Status

    Done
    docs issues

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions