DOC Use .. deprecated for deprecation instead of .. note (#120)

numpy · Oct 31, 2017 · 9898954 · 9898954
1 parent 778fcc1
commit 9898954
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/format.rst b/doc/format.rst
@@ -127,12 +127,12 @@ The sections of the docstring are:
 
    * New recommended way of obtaining the same functionality.
 
-   This section should use the note Sphinx directive instead of an
+   This section should use the ``deprecated`` Sphinx directive instead of an
    underlined section header.
 
    ::
 
-     .. note:: Deprecated in NumPy 1.6.0
+     .. deprecated:: 1.6.0
                `ndobj_old` will be removed in NumPy 2.0.0, it is replaced by
                `ndobj_new` because the latter works also with array subclasses.