DOC Ensures that function passes numpydoc validation: has_fit_parameter (#21590)

reshamas · web-flow · commit d40943a57690 · 2021-11-15T08:22:56.000+01:00
diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py
@@ -218,7 +218,6 @@
     "sklearn.utils.validation.check_memory",
     "sklearn.utils.validation.check_random_state",
     "sklearn.utils.validation.column_or_1d",
-    "sklearn.utils.validation.has_fit_parameter",
 ]
 FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)
 
diff --git a/sklearn/utils/validation.py b/sklearn/utils/validation.py
@@ -1159,7 +1159,7 @@ def check_random_state(seed):
 
 
 def has_fit_parameter(estimator, parameter):
-    """Checks whether the estimator's fit method supports the given parameter.
+    """Check whether the estimator's fit method supports the given parameter.
 
     Parameters
     ----------
@@ -1171,7 +1171,7 @@ def has_fit_parameter(estimator, parameter):
 
     Returns
     -------
-    is_parameter: bool
+    is_parameter : bool
         Whether the parameter was found to be a named parameter of the
         estimator's fit method.
 
@@ -1181,7 +1181,6 @@ def has_fit_parameter(estimator, parameter):
     >>> from sklearn.utils.validation import has_fit_parameter
     >>> has_fit_parameter(SVC(), "sample_weight")
     True
-
     """
     return parameter in signature(estimator.fit).parameters
 

Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,6 @@`
`218`	`218`	`"sklearn.utils.validation.check_memory",`
`219`	`219`	`"sklearn.utils.validation.check_random_state",`
`220`	`220`	`"sklearn.utils.validation.column_or_1d",`
`221`		`- "sklearn.utils.validation.has_fit_parameter",`
`222`	`221`	`]`
`223`	`222`	`FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)`
`224`	`223`