encodings module is not documented

Feature or enhancement

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

Lines 1 to 29 in 23caccf

    
8F6A
        
           """ 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

gh-136162: Document encodings #136164

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Feature or enhancement

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	""" 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.

	"""#"

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

	.. module:: encodings.idna
	:synopsis: Internationalized Domain Names implementation

Uh oh!

Description

Feature or enhancement

Linked PRs

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions