DOC Ensures that PLSRegression passes numpydoc validation (#21208)

jmloyola · web-flow · commit 39f7790e3d32 · 2021-10-01T11:49:23.000+02:00
diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py
@@ -20,7 +20,6 @@
     "MultiTaskLassoCV",
     "OrthogonalMatchingPursuit",
     "OrthogonalMatchingPursuitCV",
-    "PLSRegression",
     "PassiveAggressiveClassifier",
     "PassiveAggressiveRegressor",
     "PatchExtractor",
diff --git a/sklearn/cross_decomposition/_pls.py b/sklearn/cross_decomposition/_pls.py
@@ -549,7 +549,7 @@ def _more_tags(self):
 
 
 class PLSRegression(_PLS):
-    """PLS regression
+    """PLS regression.
 
     PLSRegression is also known as PLS2 or PLS1, depending on the number of
     targets.
@@ -577,9 +577,9 @@ class PLSRegression(_PLS):
         than `tol`, where `u` corresponds to the left singular vector.
 
     copy : bool, default=True
-        Whether to copy `X` and `Y` in fit before applying centering, and
-        potentially scaling. If False, these operations will be done inplace,
-        modifying both arrays.
+        Whether to copy `X` and `Y` in :term:`fit` before applying centering,
+        and potentially scaling. If `False`, these operations will be done
+        inplace, modifying both arrays.
 
     Attributes
     ----------
@@ -626,6 +626,10 @@ class PLSRegression(_PLS):
 
         .. versionadded:: 1.0
 
+    See Also
+    --------
+    PLSCanonical : Partial Least Squares transformer and regressor.
+
     Examples
     --------
     >>> from sklearn.cross_decomposition import PLSRegression
