Skip to content

Commit bd1bc1b

Browse files
committed
docs: minor README update
1 parent f70ac0c commit bd1bc1b

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ If in doubt just ask, or look at the examples in the codebase.
100100
* More involved type hints can have extra information in the
101101
docstring. For example for numpy arrays, ``npt.NDArray[np.bool]`` doesn't
102102
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)``.
103+
Therefore, you can also keep the docstring parameter description with
104+
the shape and dtype information e.g., ``binary ndarray of shape (M, N)``.
105105

106106

107107
Incrementing version

0 commit comments

Comments
 (0)