DOC standardized formatting for default values in transformer class. (scikit-learn#17505)

ezebunandu · Sam Ezebunandu · jayzed82 · commit 4234c431e06f · 2020-10-22T14:42:54.000+02:00
* DOC_standardized formatting for default values in transformer class.

* DOC_use type bool instead of boolean

Co-authored-by: Sam Ezebunandu &lt;samuel.ezebunandu@outlook.com&gt;
diff --git a/sklearn/preprocessing/_function_transformer.py b/sklearn/preprocessing/_function_transformer.py
@@ -28,18 +28,18 @@ class FunctionTransformer(TransformerMixin, BaseEstimator):
 
     Parameters
     ----------
-    func : callable, optional default=None
+    func : callable, default=None
         The callable to use for the transformation. This will be passed
         the same arguments as transform, with args and kwargs forwarded.
         If func is None, then func will be the identity function.
 
-    inverse_func : callable, optional default=None
+    inverse_func : callable, default=None
         The callable to use for the inverse transformation. This will be
         passed the same arguments as inverse transform, with args and
         kwargs forwarded. If inverse_func is None, then inverse_func
         will be the identity function.
 
-    validate : bool, optional default=False
+    validate : bool, default=False
         Indicate that the input X array should be checked before calling
         ``func``. The possibilities are:
 
@@ -51,7 +51,7 @@ class FunctionTransformer(TransformerMixin, BaseEstimator):
         .. versionchanged:: 0.22
            The default of ``validate`` changed from True to False.
 
-    accept_sparse : boolean, optional
+    accept_sparse : bool, default=False
         Indicate that func accepts a sparse matrix as input. If validate is
         False, this has no effect. Otherwise, if accept_sparse is false,
         sparse matrix inputs will cause an exception to be raised.
@@ -63,12 +63,12 @@ class FunctionTransformer(TransformerMixin, BaseEstimator):
 
        .. versionadded:: 0.20
 
-    kw_args : dict, optional
+    kw_args : dict, default=None
         Dictionary of additional keyword arguments to pass to func.
 
         .. versionadded:: 0.18
 
-    inv_kw_args : dict, optional
+    inv_kw_args : dict, default=None
         Dictionary of additional keyword arguments to pass to inverse_func.
 
         .. versionadded:: 0.18
