DOC: Add missing documentation for top-level functions #10106
Description
Exposed are:
-
<function <lambda> at 0x0000026322836C80>(np.deprecate_with_doc) -
<class 'numpy._import_tools.PackageLoader'>(np.PackageLoader) -
<class 'numpy.core._internal.TooHardError'>(np.TooHardError) - DOC: adding docstring to TooHardError class #21471 -
<function _numpy_tester at 0x000002632285C268>(np._numpy_tester) -
<built-in function compare_chararrays>(np.compare_chararrays) - DOC: add a docstring for the function 'compare_chararrays' (See #10106) #12338 -
<built-in function datetime_as_string>(np.datetime_as_string) - DOC: Add documentation for datetime_as_string #10107 -
<built-in function datetime_data>(np.datetime_data) - DOC: Add documentation for datetime_data #10108 -
<built-in function int_asbuffer>(np.int_asbuffer) - Remove int_asbuffer #12425 -
<built-in function nested_iters>(np.nested_iters) - DOC: nditer.nested_iters are not documented #10009 -
<function show at 0x00000263225800D0>(np.show_config) -show_config()has no docstring and is not in the online docs. #9258 -
<class 'numpy.bytes_'>(np.bytes0,np.string_,np.bytes_) -
<class 'numpy.character'>(np.character) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.complexfloating'>(np.complexfloating) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.datetime64'>(np.datetime64) - datetime64("now") is undocumented #10003, datetime64 not present in intersphinx inventory #10039, ... -
<class 'numpy.flexible'>(np.flexible) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.float16'>(np.half,np.float16) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.float64'>(np.longdouble,np.longfloat) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.floating'>(np.floating) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.inexact'>(np.inexact) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.int32'>(np.intc) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.integer'>(np.integer) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.number'>(np.number) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.signedinteger'>(np.signedinteger) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.str_'>(np.str0,np.unicode_,np.str_) -
<class 'numpy.timedelta64'>(np.timedelta64) -
<class 'numpy.uint16'>(np.uint16,np.ushort) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.uint32'>(np.uintc) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.uint32'>(np.uint,np.uint32) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.uint64'>(np.uint64,np.uintp,np.ulonglong,np.uint0) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.uint8'>(np.uint8,np.ubyte) - DOC: add docstrings for numeric types #11858 -
<class 'numpy.unsignedinteger'>(np.unsignedinteger) - DOC: Add docstrings for abstract types in scalar type hierarchy #12027 -
<class 'numpy.void'>(np.void0,np.void)
Steps to document many of these:
- Find the long-form of the name, such as
np.core.multiarray.uint16 - Add the documentation
toin the appropriate placenumpy/add_newdocs.py - Find an appropriate place to link to the function within
:/doc/source/reference/routines.*.rst- look at existing files to see how
Script to generate the above
from collections.abc import Callable
ndoc = set(
v
for k, v in vars(np).items()
if isinstance(v, Callable) and v.__doc__ is None
)
ndoc = sorted(
ndoc,
key=lambda v: (isinstance(v, type) and issubclass(v, np .generic), v.__qualname__)
)
print('\n'.join(
'* [ ] `{!r}` ({})'.format(
v,
', '.join('`np.{}`'.format(k) for k, v2 in vars(np).items() if v2 is v)
)
for v in ndoc
))