[issue11776] Constructor signatures missing in types module documentation
Nick Coghlan
report at bugs.python.org
Wed Aug 22 12:20:32 CEST 2012
Nick Coghlan added the comment:
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.
----------
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11776>
_______________________________________
More information about the Python-bugs-list
mailing list