Rm redundant numpydoc_validate config param.

Author: rossbar

doc/conf.py

@@ -85,7 +85,6 @@
 numpydoc_xref_param_type = True
 numpydoc_xref_ignore = {'optional', 'type_without_description', 'BadException'}
 # Run docstring validation as part of build process
-numpydoc_validate = True
 numpydoc_validation_checks = {"all", "GL01", "SA04", "RT03"}
 
 # The language for content autogenerated by Sphinx. Refer to documentation

doc/install.rst

@@ -96,12 +96,10 @@ numpydoc_xref_ignore : set or ``"all"``
   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_validate : bool
-    Whether or not to run docstring validation during the sphinx-build process.
-    Default is ``False``.
 numpydoc_validation_checks : set
     The set of validation checks to report during the sphinx build process.
-    Only has an effect when ``numpydoc_validate = True``.
+    The default is an empty set, so docstring validation is not run by
+    default.
     If ``"all"`` is in the set, then the results of all of the
     :ref:`built-in validation checks <validation_checks>` are reported.
     If the set includes ``"all"`` and additional error codes, then all
@@ -118,9 +116,6 @@ numpydoc_validation_checks : set
 
         # Only report warnings for the SA01 and EX01 checks
         numpydoc_validation_checks = {"SA01", "EX01"}
-
-    The default is an empty set, thus no warnings from docstring validation
-    are reported.
 numpydoc_validation_exclude : set
     A container of strings using :py:mod:`re` syntax specifying patterns to
     ignore for docstring validation.
@@ -134,8 +129,9 @@ numpydoc_validation_exclude : set
         numpydoc_validation_exclude = {r"mypkg\.mymodule\.", r"MyClass\.get$"}
 
     The default is an empty set meaning no objects are excluded from docstring
-    validation by default.
-    Only has an effect when ``numpydoc_validate = True``.
+    validation.
+    Only has an effect when docstring validation is activated, i.e.
+    ``numpydoc_validation_checks`` is not an empty set.
 numpydoc_edit_link : bool
   .. deprecated:: 0.7.0
 

numpydoc/numpydoc.py

@@ -174,7 +174,7 @@ def mangle_docstrings(app, what, name, obj, options, lines):
             logger.error('[numpydoc] While processing docstring for %r', name)
             raise
 
-        if app.config.numpydoc_validate:
+        if app.config.numpydoc_validation_checks:
             # If the user has supplied patterns to ignore via the
             # numpydoc_validation_exclude config option, skip validation for
             # any objs whose name matches any of the patterns
@@ -277,7 +277,6 @@ def setup(app, get_doc_object_=get_doc_object):
     app.add_config_value('numpydoc_xref_param_type', False, True)
     app.add_config_value('numpydoc_xref_aliases', dict(), True)
     app.add_config_value('numpydoc_xref_ignore', set(), True)
-    app.add_config_value('numpydoc_validate', False, True)
     app.add_config_value('numpydoc_validation_checks', set(), True)
     app.add_config_value('numpydoc_validation_exclude', set(), False)
 

numpydoc/tests/test_numpydoc.py

@@ -24,7 +24,6 @@ class MockConfig():
     numpydoc_edit_link = False
     numpydoc_citation_re = '[a-z0-9_.-]+'
     numpydoc_attributes_as_param_list = True
-    numpydoc_validate = False
     numpydoc_validation_checks = set()
     numpydoc_validation_exclude = set()
 
@@ -117,30 +116,27 @@ def _function_without_seealso_and_examples():
 
 @pytest.mark.parametrize(
     (
-        'numpydoc_validate',
         'numpydoc_validation_checks',
         'expected_warn',
         'non_warnings',
     ),
     (
         # Validation configured off - expect no warnings
-        (False, set(['SA01', 'EX01']), [], []),
+        (set(), [], []),
         # Validation on with expected warnings
-        (True, set(['SA01', 'EX01']), ('SA01', 'EX01'), []),
+        (set(['SA01', 'EX01']), ('SA01', 'EX01'), []),
         # Validation on with only one activated check
-        (True, set(['SA01']), ('SA01',), ('EX01',)),
+        (set(['SA01']), ('SA01',), ('EX01',)),
     ),
 )
 def test_mangle_docstring_validation_warnings(
     f,
-    numpydoc_validate,
     numpydoc_validation_checks,
     expected_warn,
     non_warnings,
 ):
     app = MockApp()
     # Set up config for test
-    app.config.numpydoc_validate = numpydoc_validate
     app.config.numpydoc_validation_checks = numpydoc_validation_checks
     # Update configuration
     update_config(app)
@@ -162,7 +158,6 @@ def function_with_bad_docstring():
         """
         This docstring will raise docstring validation warnings."""
     app = MockApp()
-    app.config.numpydoc_validate = True
     app.config.numpydoc_validation_checks = {"all"}
     app.config.numpydoc_validation_exclude = [r"_bad_"]
     # Call update_config to construct regexp from config value

numpydoc/tests/tinybuild/conf.py

@@ -22,4 +22,3 @@
 highlight_language = 'python3'
 numpydoc_class_members_toctree = False
 numpydoc_xref_param_type = True
-numpydoc_validate = True