Skip to content

Commit 79b381f

Browse files
authored
Merge pull request numpy#20325 from bzah/doc/remove-alias-of-percentile-lerp
DOC: Remove non-existent quantile `interpolation="inclusive"` alias
2 parents 5cc7ef0 + 035d853 commit 79b381f

File tree

3 files changed

+10
-13
lines changed

3 files changed

+10
-13
lines changed

numpy/lib/function_base.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3901,7 +3901,7 @@ def percentile(a,
39013901
* (NPY 2): 'higher',
39023902
* (NPY 3): 'midpoint'
39033903
* (NPY 4): 'nearest'
3904-
* (NPY 5): 'linear', aliased with 'inclusive' (default)
3904+
* (NPY 5): 'linear'
39053905
39063906
New options:
39073907
@@ -3911,7 +3911,7 @@ def percentile(a,
39113911
* (H&F 4): 'interpolated_inverted_cdf'
39123912
* (H&F 5): 'hazen'
39133913
* (H&F 6): 'weibull'
3914-
* (H&F 7): 'inclusive', aliased with 'linear' (default)
3914+
* (H&F 7): 'linear' (default)
39153915
* (H&F 8): 'median_unbiased'
39163916
* (H&F 9): 'normal_unbiased'
39173917
@@ -4007,8 +4007,7 @@ def percentile(a,
40074007
* alpha = 0
40084008
* beta = 0
40094009
4010-
inclusive:
4011-
Default method, aliased with "linear".
4010+
linear:
40124011
method 7 of H&F [1]_.
40134012
This method give continuous results using:
40144013
* alpha = 1
@@ -4164,7 +4163,7 @@ def quantile(a,
41644163
* (NPY 2): 'higher',
41654164
* (NPY 3): 'midpoint'
41664165
* (NPY 4): 'nearest'
4167-
* (NPY 5): 'linear', aliased with 'inclusive' (default)
4166+
* (NPY 5): 'linear'
41684167
41694168
New options:
41704169
@@ -4174,7 +4173,7 @@ def quantile(a,
41744173
* (H&F 4): 'interpolated_inverted_cdf'
41754174
* (H&F 5): 'hazen'
41764175
* (H&F 6): 'weibull'
4177-
* (H&F 7): 'inclusive', aliased with 'linear' (default)
4176+
* (H&F 7): 'linear' (default)
41784177
* (H&F 8): 'median_unbiased'
41794178
* (H&F 9): 'normal_unbiased'
41804179
@@ -4261,8 +4260,7 @@ def quantile(a,
42614260
* alpha = 0
42624261
* beta = 0
42634262
4264-
inclusive:
4265-
Default method, aliased with "linear".
4263+
linear:
42664264
method 7 of H&F [1]_.
42674265
This method give continuous results using:
42684266
* alpha = 1

numpy/lib/function_base.pyi

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,6 @@ _InterpolationKind = L[
514514
"higher",
515515
"midpoint",
516516
"nearest",
517-
"inclusive",
518517
]
519518

520519
@overload

numpy/lib/nanfunctions.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1277,7 +1277,7 @@ def nanpercentile(
12771277
* (NPY 2): 'higher',
12781278
* (NPY 3): 'midpoint'
12791279
* (NPY 4): 'nearest'
1280-
* (NPY 5): 'linear', aliased with 'inclusive' (default)
1280+
* (NPY 5): 'linear' (default)
12811281
12821282
New options:
12831283
@@ -1287,7 +1287,7 @@ def nanpercentile(
12871287
* (H&F 4): 'interpolated_inverted_cdf'
12881288
* (H&F 5): 'hazen'
12891289
* (H&F 6): 'weibull'
1290-
* (H&F 7): 'inclusive', aliased with 'linear' (default)
1290+
* (H&F 7): 'linear' (default)
12911291
* (H&F 8): 'median_unbiased'
12921292
* (H&F 9): 'normal_unbiased'
12931293
@@ -1418,7 +1418,7 @@ def nanquantile(
14181418
* (NPY 2): 'higher',
14191419
* (NPY 3): 'midpoint'
14201420
* (NPY 4): 'nearest'
1421-
* (NPY 5): 'linear', aliased with 'inclusive' (default)
1421+
* (NPY 5): 'linear' (default)
14221422
14231423
New options:
14241424
@@ -1428,7 +1428,7 @@ def nanquantile(
14281428
* (H&F 4): 'interpolated_inverted_cdf'
14291429
* (H&F 5): 'hazen'
14301430
* (H&F 6): 'weibull'
1431-
* (H&F 7): 'inclusive', aliased with 'linear' (default)
1431+
* (H&F 7): 'linear' (default)
14321432
* (H&F 8): 'median_unbiased'
14331433
* (H&F 9): 'normal_unbiased'
14341434

0 commit comments

Comments
 (0)