File tree 1 file changed +10
-3
lines changed
1 file changed +10
-3
lines changed Original file line number Diff line number Diff line change @@ -11133,12 +11133,19 @@ def pct_change(
11133
11133
** kwargs ,
11134
11134
) -> Self :
11135
11135
"""
11136
- Percentage change between the current and a prior element.
11136
+ Fractional change between the current and a prior element.
11137
11137
11138
- Computes the percentage change from the immediately previous row by
11139
- default. This is useful in comparing the percentage of change in a time
11138
+ Computes the fractional change from the immediately previous row by
11139
+ default. This is useful in comparing the fraction of change in a time
11140
11140
series of elements.
11141
11141
11142
+ .. note::
11143
+
11144
+ Despite the name of this method, it calculates fractional change
11145
+ (also known as per unit change or relative change) and not
11146
+ percentage change. If you need the percentage change, multiply
11147
+ these values by 100.
11148
+
11142
11149
Parameters
11143
11150
----------
11144
11151
periods : int, default 1
You can’t perform that action at this time.
0 commit comments