@@ -850,7 +850,38 @@ def mean(self, *args, **kwargs):
850
850
return self ._apply ('roll_mean' , 'mean' , ** kwargs )
851
851
852
852
_shared_docs ['median' ] = dedent ("""
853
- %(name)s median
853
+ Calculate the %(name)s median.
854
+
855
+ Parameters
856
+ ----------
857
+ **kwargs
858
+ For compatibility with other %(name)s methods. Has no effect
859
+ on the computed median.
860
+
861
+ Returns
862
+ -------
863
+ Series or DataFrame
864
+ Returned type is the same as the original object.
865
+
866
+ See Also
867
+ --------
868
+ Series.%(name)s : Calling object with Series data
869
+ DataFrame.%(name)s : Calling object with DataFrames
870
+ Series.median : Equivalent method for Series
871
+ DataFrame.median : Equivalent method for DataFrame
872
+
873
+ Examples
874
+ --------
875
+ Compute the rolling median of a series with a window size of 3.
876
+
877
+ >>> s = pd.Series([0, 1, 2, 3, 4])
878
+ >>> s.rolling(3).median()
879
+ 0 NaN
880
+ 1 NaN
881
+ 2 1.0
882
+ 3 2.0
883
+ 4 3.0
884
+ dtype: float64
854
885
""" )
855
886
856
887
def median (self , ** kwargs ):
@@ -1321,7 +1352,6 @@ def mean(self, *args, **kwargs):
1321
1352
return super (Rolling , self ).mean (* args , ** kwargs )
1322
1353
1323
1354
@Substitution (name = 'rolling' )
1324
- @Appender (_doc_template )
1325
1355
@Appender (_shared_docs ['median' ])
1326
1356
def median (self , ** kwargs ):
1327
1357
return super (Rolling , self ).median (** kwargs )
@@ -1583,7 +1613,6 @@ def mean(self, *args, **kwargs):
1583
1613
return super (Expanding , self ).mean (* args , ** kwargs )
1584
1614
1585
1615
@Substitution (name = 'expanding' )
1586
- @Appender (_doc_template )
1587
1616
@Appender (_shared_docs ['median' ])
1588
1617
def median (self , ** kwargs ):
1589
1618
return super (Expanding , self ).median (** kwargs )
0 commit comments