Skip to content

Commit 9898954

Browse files
authored
DOC Use .. deprecated for deprecation instead of .. note (#120)
1 parent 778fcc1 commit 9898954

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/format.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,12 @@ The sections of the docstring are:
127127

128128
* New recommended way of obtaining the same functionality.
129129

130-
This section should use the note Sphinx directive instead of an
130+
This section should use the ``deprecated`` Sphinx directive instead of an
131131
underlined section header.
132132

133133
::
134134

135-
.. note:: Deprecated in NumPy 1.6.0
135+
.. deprecated:: 1.6.0
136136
`ndobj_old` will be removed in NumPy 2.0.0, it is replaced by
137137
`ndobj_new` because the latter works also with array subclasses.
138138

0 commit comments

Comments
 (0)