Minor Documentation Issues
Author: kmaehashiCreated Mar 18, 2021Updated Sep 14, 2026
Labelscontribution welcomecat:documentprio:mediumgood first issue
This issue tracks minor documentation errors that are easy to fix. (typos, syntax errors, outdated documentation that just needs removal, functions unlisted in the API list).
Broken docstring formats
- https://docs.cupy.dev/en/latest/reference/generated/cupy.cuda.using_allocator.html
- https://docs.cupy.dev/en/latest/reference/generated/cupyx.distributed.init_process_group.html >
Returns: - https://docs.cupy.dev/en/stable/reference/generated/cupyx.scipy.ndimage.affine_transform.html >
texture_memory - https://docs.cupy.dev/en/latest/reference/generated/cupyx.scipy.special.erf.html#cupyx.scipy.special.erf >
scipy.special.erf()
Outdated docstrings
-
cupy.asarraydocstring saysThis function currently does not support the order option.but this is no longer valid and should be removed.
Missing API Reference
Functions rendered as red in CuPy column of the Comparison Table lacks documentation.
-
cupy.max -
cupy.min -
cupy.ndim -
cupy.round -
cupy.size -
cupy.lib.stride_tricks.sliding_window_view -
cupyx.scipy.linalg.bandwidth -
cupyx.scipy.linalg.khatri_rao -
cupyx.scipy.special.binom -
cupyx.scipy.special.ellipj -
cupyx.scipy.special.ellipk -
cupyx.scipy.special.ellipkm1 -
cupyx.scipy.special.gammasgn
Source: cupy/cupy