We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent f70ac0c commit bd1bc1bCopy full SHA for bd1bc1b
1 file changed
README.rst
@@ -100,8 +100,8 @@ If in doubt just ask, or look at the examples in the codebase.
100
* More involved type hints can have extra information in the
101
docstring. For example for numpy arrays, ``npt.NDArray[np.bool]`` doesn't
102
render in a readable way in the Code Reference, and doesn't include shape.
103
- Therefore, you can also keep the docstring parameter description e.g.,
104
- ``binary ndarray of shape (M, N)``.
+ Therefore, you can also keep the docstring parameter description with
+ the shape and dtype information e.g., ``binary ndarray of shape (M, N)``.
105
106
107
Incrementing version
0 commit comments