-
-
Notifications
You must be signed in to change notification settings - Fork 11.1k
Closed
Description
Issue with current documentation:
In both VSCode and PyCharm, when hovering over np.quantile
the IDE displays def percentile ...
and the corresponding docstring. Although the function signatures are identical, q
s range is not. Currently, IDEs tell developers q
for np.quantile
should be 0-100, which is not correct.
Idea or request for content:
The cause appears to be at
numpy/numpy/lib/_function_base_impl.pyi
Lines 775 to 777 in 3727d5b
# NOTE: Not an alias, but they do have identical signatures | |
# (that we can reuse) | |
quantile = percentile |
The assignment tricks the IDE into thinking quantile
is an alias for percentile
so pulls the incorrect info. Would a PR that duplicates the percentile
type stubs for quantile
be accepted or is the added maintenance burden not worth it?