DOC Ensure TheilSenRegressor passes numpydoc validation (#21087)

EricEllwanger · frellwan · web-flow · commit 07f4e4c99d81 · 2021-09-20T22:56:55.000+02:00
Co-authored-by: frellwan &lt;frellwan@hotmail.com&gt;
diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py
@@ -45,7 +45,6 @@
     "SplineTransformer",
     "StackingClassifier",
     "StackingRegressor",
-    "TheilSenRegressor",
     "TransformedTargetRegressor",
     "TweedieRegressor",
 ]
diff --git a/sklearn/linear_model/_theil_sen.py b/sklearn/linear_model/_theil_sen.py
@@ -255,7 +255,7 @@ class TheilSenRegressor(RegressorMixin, LinearModel):
         A random number generator instance to define the state of the random
         permutations generator. Pass an int for reproducible output across
         multiple function calls.
-        See :term:`Glossary <random_state>`
+        See :term:`Glossary <random_state>`.
 
     n_jobs : int, default=None
         Number of CPUs to use during the cross validation.
@@ -295,6 +295,18 @@ class TheilSenRegressor(RegressorMixin, LinearModel):
 
         .. versionadded:: 1.0
 
+    See Also
+    --------
+    HuberRegressor : Linear regression model that is robust to outliers.
+    RANSACRegressor : RANSAC (RANdom SAmple Consensus) algorithm.
+    SGDRegressor : Fitted by minimizing a regularized empirical loss with SGD.
+
+    References
+    ----------
+    - Theil-Sen Estimators in a Multiple Linear Regression Model, 2009
+      Xin Dang, Hanxiang Peng, Xueqin Wang and Heping Zhang
+      http://home.olemiss.edu/~xdang/papers/MTSE.pdf
+
     Examples
     --------
     >>> from sklearn.linear_model import TheilSenRegressor
@@ -306,12 +318,6 @@ class TheilSenRegressor(RegressorMixin, LinearModel):
     0.9884...
     >>> reg.predict(X[:1,])
     array([-31.5871...])
-
-    References
-    ----------
-    - Theil-Sen Estimators in a Multiple Linear Regression Model, 2009
-      Xin Dang, Hanxiang Peng, Xueqin Wang and Heping Zhang
-      http://home.olemiss.edu/~xdang/papers/MTSE.pdf
     """
 
     def __init__(
@@ -394,6 +400,7 @@ def fit(self, X, y):
         Returns
         -------
         self : returns an instance of self.
+            Fitted `TheilSenRegressor` estimator.
         """
         random_state = check_random_state(self.random_state)
         X, y = self._validate_data(X, y, y_numeric=True)

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,6 @@`
`45`	`45`	`"SplineTransformer",`
`46`	`46`	`"StackingClassifier",`
`47`	`47`	`"StackingRegressor",`
`48`		`- "TheilSenRegressor",`
`49`	`48`	`"TransformedTargetRegressor",`
`50`	`49`	`"TweedieRegressor",`
`51`	`50`	`]`