DOC Ensures that GammaRegressor passes numpydoc validation (scikit-learn#20973)

baam25simo · ogrisel · web-flow · commit 289dab9a871d · 2021-09-08T17:33:56.000+02:00
Co-authored-by: Olivier Grisel &lt;olivier.grisel@ensta.org&gt;
diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py
@@ -9,7 +9,6 @@
 
 # List of modules ignored when checking for numpydoc validation.
 DOCSTRING_IGNORE_LIST = [
-    "GammaRegressor",
     "GaussianProcessRegressor",
     "GaussianRandomProjection",
     "GridSearchCV",
diff --git a/sklearn/linear_model/_glm/glm.py b/sklearn/linear_model/_glm/glm.py
@@ -606,6 +606,11 @@ class GammaRegressor(GeneralizedLinearRegressor):
 
         .. versionadded:: 1.0
 
+    See Also
+    --------
+    PoissonRegressor : Generalized Linear Model with a Poisson distribution.
+    TweedieRegressor : Generalized Linear Model with a Tweedie distribution.
+
     Examples
     --------
     >>> from sklearn import linear_model
@@ -648,6 +653,7 @@ def __init__(
 
     @property
     def family(self):
+        """Return the family of the regressor."""
         # Make this attribute read-only to avoid mis-uses e.g. in GridSearch.
         return "gamma"
 
