-
-
Notifications
You must be signed in to change notification settings - Fork 19.1k
Closed
Labels
Closing CandidateMay be closeable, needs more eyeballsMay be closeable, needs more eyeballsConstructorsSeries/DataFrame/Index/pd.array ConstructorsSeries/DataFrame/Index/pd.array ConstructorsDocsNeeds DiscussionRequires discussion from core team before further actionRequires discussion from core team before further action
Description
Pandas version checks
- I have checked that the issue still exists on the latest versions of the docs on
main
here
Location of the documentation
https://pandas.pydata.org/docs/dev/reference/api/pandas.Series.html#pandas.Series
Documentation problem
The public api contains internally used parameter. In this case the Series constructor contains fastpath
parameter which isn't documented in the docstring. However, is part of the constructor signature.
Suggested fix for documentation
Suggested solution:
- Prefix the internally used/private parameter with an underscore (
_
) - Remove all the parameters starging with an underscore while processing the method signatures in sphinx.
This problem is already identified in a very old issue: #6903
Metadata
Metadata
Assignees
Labels
Closing CandidateMay be closeable, needs more eyeballsMay be closeable, needs more eyeballsConstructorsSeries/DataFrame/Index/pd.array ConstructorsSeries/DataFrame/Index/pd.array ConstructorsDocsNeeds DiscussionRequires discussion from core team before further actionRequires discussion from core team before further action