Skip to content

DOC: Remove internally used/private parameters from method signatures #52028

@numanijaz

Description

@numanijaz

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:

  1. Prefix the internally used/private parameter with an underscore (_)
  2. 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

No one assigned

    Labels

    Closing CandidateMay be closeable, needs more eyeballsConstructorsSeries/DataFrame/Index/pd.array ConstructorsDocsNeeds DiscussionRequires discussion from core team before further action

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions