From 86657f01d2efce1068663fac0ddf3dcaaa31cabd Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 21 Jan 2021 17:28:13 +0100 Subject: [PATCH 1/4] fix format: add linebreak --- doc/install.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index d80e7a71..d1c9346d 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -78,7 +78,7 @@ numpydoc_xref_aliases : dict being ``True``. numpydoc_xref_ignore : set or ``"all"`` How to handle terms not in ``numpydoc_xref_aliases`` when - ``numpydoc_xref_aliases=True``. The value can either be a ``set`` + ``numpydoc_xref_aliases=True``. The value can either be a ``set`` containing terms to ignore, or ``"all"``. In the former case, the set contains words not to cross-reference. Most likely, these are common words used in parameter type descriptions that may be confused for @@ -97,6 +97,7 @@ numpydoc_xref_ignore : set or ``"all"`` ``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing terms to ignore in a set. numpydoc_edit_link : bool - .. deprecated:: edit your HTML template instead + .. deprecated:: + edit your HTML template instead Whether to insert an edit link after docstrings. From 6fd5037386089adc7f6658e927df9b4ba728bbb0 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 21 Jan 2021 17:28:29 +0100 Subject: [PATCH 2/4] consistent indent --- doc/install.rst | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index d1c9346d..5102c2be 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -77,25 +77,25 @@ numpydoc_xref_aliases : dict This option depends on the ``numpydoc_xref_param_type`` option being ``True``. numpydoc_xref_ignore : set or ``"all"`` - How to handle terms not in ``numpydoc_xref_aliases`` when - ``numpydoc_xref_aliases=True``. The value can either be a ``set`` - containing terms to ignore, or ``"all"``. In the former case, the set - contains words not to cross-reference. Most likely, these are common words - used in parameter type descriptions that may be confused for - classes of the same name. For example:: - - numpydoc_xref_ignore = {'type', 'optional', 'default'} - - The default is an empty set. - - If the ``numpydoc_xref_ignore="all"``, then all unrecognized terms are - ignored, i.e. terms not in ``numpydoc_xref_aliases`` are *not* wrapped in - ``:obj:`` roles. - This configuration parameter may be useful if you only want create - cross references for a small number of terms. In this case, including the - desired cross reference mappings in ``numpydoc_xref_aliases`` and setting - ``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing - terms to ignore in a set. + How to handle terms not in ``numpydoc_xref_aliases`` when + ``numpydoc_xref_aliases=True``. The value can either be a ``set`` + containing terms to ignore, or ``"all"``. In the former case, the set + contains words not to cross-reference. Most likely, these are common words + used in parameter type descriptions that may be confused for + classes of the same name. For example:: + + numpydoc_xref_ignore = {'type', 'optional', 'default'} + + The default is an empty set. + + If the ``numpydoc_xref_ignore="all"``, then all unrecognized terms are + ignored, i.e. terms not in ``numpydoc_xref_aliases`` are *not* wrapped in + ``:obj:`` roles. + This configuration parameter may be useful if you only want create + cross references for a small number of terms. In this case, including the + desired cross reference mappings in ``numpydoc_xref_aliases`` and setting + ``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing + terms to ignore in a set. numpydoc_edit_link : bool .. deprecated:: edit your HTML template instead From 11bc5555b2eccc1a87d08a331657b4475d5e90bd Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 21 Jan 2021 17:50:49 +0100 Subject: [PATCH 3/4] add deprecation version arg to numpydoc_edit_link --- doc/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/install.rst b/doc/install.rst index 5102c2be..f359e0da 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -97,7 +97,7 @@ numpydoc_xref_ignore : set or ``"all"`` ``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing terms to ignore in a set. numpydoc_edit_link : bool - .. deprecated:: + .. deprecated:: 0.7.0 edit your HTML template instead Whether to insert an edit link after docstrings. From 2297354a87813d5c9606a22fc8f2ada504168e7e Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 21 Jan 2021 17:54:15 +0100 Subject: [PATCH 4/4] add blank line after directive --- doc/install.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/install.rst b/doc/install.rst index f359e0da..6139efea 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -98,6 +98,7 @@ numpydoc_xref_ignore : set or ``"all"`` terms to ignore in a set. numpydoc_edit_link : bool .. deprecated:: 0.7.0 + edit your HTML template instead Whether to insert an edit link after docstrings.