Author ncoghlan
Recipients docs@python, eric.araujo, georg.brandl, guandalino, mikehoy, ncoghlan, techtonik, terry.reedy
Date 2012-08-22.10:20:32
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1345630832.91.0.639735176676.issue11776@psf.upfronthosting.co.za>
In-reply-to
Content
The first easy part of this patch is to document the signatures for types in that module where that info is available in the docstring:

CodeType
FunctionType
LambdaType
SimpleNamespace
MethodType

The second easy part is that the following need to be documented as not supporting direct creation from Python code:

BuiltinFunctionType
BuiltinMethodType
FrameType
GeneratorType
GetSetDescriptorType
MemberDescriptorType
TracebackType 

This type does support direct creation and should be documented appropriately, but the docs should also direct readers to the preferred API in the imp module:

ModuleType (imp.new_module)


Finally, this one is missing both a docstring *and* signature documentation:
MappingProxyType

It's a simple API that accepts a single parameter (which must be a mapping) and returns a read-only view of the original mapping.
History
Date User Action Args
2012-08-22 10:20:32ncoghlansetrecipients: + ncoghlan, georg.brandl, terry.reedy, techtonik, eric.araujo, docs@python, guandalino, mikehoy
2012-08-22 10:20:32ncoghlansetmessageid: <1345630832.91.0.639735176676.issue11776@psf.upfronthosting.co.za>
2012-08-22 10:20:32ncoghlanlinkissue11776 messages
2012-08-22 10:20:32ncoghlancreate