Use deprecated sphinx syntax for SparsePCA docs

naoyak · naoyak · commit 732c46cd8863 · 2016-12-31T15:47:21.000-08:00
diff --git a/sklearn/decomposition/sparse_pca.py b/sklearn/decomposition/sparse_pca.py
@@ -2,6 +2,8 @@
 # Author: Vlad Niculae, Gael Varoquaux, Alexandre Gramfort
 # License: BSD 3 clause
 
+import warnings
+
 import numpy as np
 
 from ..utils import check_random_state, check_array
@@ -10,8 +12,6 @@
 from ..base import BaseEstimator, TransformerMixin
 from .dict_learning import dict_learning, dict_learning_online
 
-import warnings
-
 
 class SparsePCA(BaseEstimator, TransformerMixin):
     """Sparse Principal Components Analysis (SparsePCA)
@@ -150,8 +150,11 @@ def transform(self, X, ridge_alpha=None):
 
         ridge_alpha: float, default: 0.01
             Amount of ridge shrinkage to apply in order to improve
-            conditioning. Note that as of 0.19 this parameter is deprecated and
-            should be specified in the constructor.
+            conditioning.
+
+            .. deprecated:: 0.19
+               This parameter will be removed in 0.21.
+               Specify `ridge_alpha` in the `SparsePCA` constructor.
 
         Returns
         -------
