[Numpy-discussion] Missing docstrings

David Huard david.huard at gmail.com
Fri Jul 7 14:46:53 EDT 2006


Hi,
For the first release, it would be nice if every function had a
docstring, even a small one. There are 279 callable items in the numpy
namespace, and 94 of those lack a docstring, albeit most of those
probably don't get much usage.  
To help the process, I filed Ticket #174 and attached a couple of
docstrings, feel free to add your own. 

Missing docstrings:
['issubsctype', 'unicode_', 'string', 'float96', 'pkgload', 'void',
'unicode0', 'void0', 'object0', 'memmap', 'nan_to_num', 'PackageLoader',
'object_', 'dtype', 'unsignedinteger', 'uintc', 'uint0', 'uint8',
'chararray', 'uint64', 'finfo', 'add_newdoc', 'array_repr', 'array_str',
'longlong', 'int16', 'mat', 'uint', 'correlate', 'int64', 'choose',
'complexfloating', 'recarray', 'mean', 'str_', 'ulonglong', 'matrix',
'uint32', 'byte', 'ctypes_load_library', 'signedinteger', 'ndim',
'number', 'bool8', 'msort', 'bool_', 'inexact', 'broadcast', 'short',
'ubyte', 'std', 'double', 'require', 'take', 'issubclass_', 'longfloat',
'deprecate', 'bincount', 'array2string', 'float64', 'ushort', 'float_',
'geterrobj', 'iterable', 'intp', 'flexible', 'sctype2char',
'longdouble', 'flatiter', 'generic', 'show_config', 'i0', 'uintp',
'character', 'uint16', 'float32', 'int32', 'integer',
'get_printoptions', 'seterrobj', 'add_docstring', 'intc', 'var', 'int_',
'histogram', 'issubdtype', 'int0', 'int8', 'record', 'obj2sctype',
'single', 'floating', 'test', 'string0'] 


Cheers, 


David

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20060707/aff2d8a0/attachment-0001.html>


More information about the NumPy-Discussion mailing list