Skip to content

Commit c55bfeb

Browse files
committed
FIX: Opt-in default
1 parent 05f55f6 commit c55bfeb

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

doc/install.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ numpydoc_xref_param_type : bool
4646
Whether to create cross-references for the parameter types in the
4747
``Parameters``, ``Other Parameters``, ``Returns`` and ``Yields``
4848
sections of the docstring.
49-
``True`` by default.
49+
``False`` by default.
5050
numpydoc_xref_aliases : dict
5151
Mappings to fully qualified paths (or correct ReST references) for the
5252
aliases/shortcuts used when specifying the types of parameters.
@@ -79,7 +79,6 @@ numpydoc_xref_aliases : dict
7979

8080
This option depends on the ``numpydoc_xref_param_type`` option
8181
being ``True``.
82-
8382
numpydoc_xref_ignore : set
8483
Words not to cross-reference. Most likely, these are common words
8584
used in parameter type descriptions that may be confused for
@@ -88,7 +87,6 @@ numpydoc_xref_ignore : set
8887
numpydoc_xref_ignore = {'type', 'optional', 'default'}
8988

9089
The default is an empty set.
91-
9290
numpydoc_edit_link : bool
9391
.. deprecated:: edit your HTML template instead
9492

numpydoc/numpydoc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ def setup(app, get_doc_object_=get_doc_object):
197197
app.add_config_value('numpydoc_show_inherited_class_members', True, True)
198198
app.add_config_value('numpydoc_class_members_toctree', True, True)
199199
app.add_config_value('numpydoc_citation_re', '[a-z0-9_.-]+', True)
200-
app.add_config_value('numpydoc_xref_param_type', True, True)
200+
app.add_config_value('numpydoc_xref_param_type', False, True)
201201
app.add_config_value('numpydoc_xref_aliases', dict(), True)
202202
app.add_config_value('numpydoc_xref_ignore', set(), True)
203203

0 commit comments

Comments
 (0)