Author lemburg
Recipients docs@python, lemburg, ncoghlan, zuo
Date 2013-11-16.13:33:13
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <52877416.9070908@egenix.com>
In-reply-to <1384608302.39.0.349312640487.issue19548@psf.upfronthosting.co.za>
Content
On 16.11.2013 14:25, Nick Coghlan wrote:
> 
> Nick Coghlan added the comment:
> 
> Another big one: the encodings module API is not documented in the prose docs, and nor is the interface between the default search function and the individual encoding definitions. There's some decent info in help(encoding) though.
> 
> The interaction with the import system could also be documented better - you can actually blacklist codecs by manipulating sys.modules and the encodings namespace, and you can search additional locations for codec modules by manipulating encodings.__path__ (even without it being declared as a namespace package)

Those were not documented on purpose, since they are an implementation
detail of the encodings package search function.

If you document them now, you'll set the implementation in stone,
making future changes to the logic difficult. I'd advise against
this to stay flexible, unless you want to open up the encodings
package as namespace package - then you'd have to add documentation
for the import interface.
History
Date User Action Args
2013-11-16 13:33:13lemburgsetrecipients: + lemburg, ncoghlan, zuo, docs@python
2013-11-16 13:33:13lemburglinkissue19548 messages
2013-11-16 13:33:13lemburgcreate