Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
NumanIjaz opened this issue Mar 16, 2023 · 3 comments
Open
1 task done
Labels
Closing Candidate May be closeable, needs more eyeballs Constructors Series/DataFrame/Index/pd.array Constructors Docs Needs Discussion Requires discussion from core team before further action

Comments

@NumanIjaz
Copy link
Contributor

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

@NumanIjaz NumanIjaz added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 16, 2023
@phofl phofl added the Needs Discussion Requires discussion from core team before further action label Mar 19, 2023
@DeaMariaLeon DeaMariaLeon removed the Needs Discussion Requires discussion from core team before further action label Mar 27, 2023
@phofl
Copy link
Member

phofl commented Mar 30, 2023

@DeaMariaLeon why did you remove the needs discussion label?

@DeaMariaLeon
Copy link
Member

DeaMariaLeon commented Mar 30, 2023

@phofl I read "needs triage" (and it is still shown on the upper right area like that).. sorry

@phofl phofl added the Needs Discussion Requires discussion from core team before further action label Mar 30, 2023
@topper-123
Copy link
Contributor

topper-123 commented May 4, 2023

We have an issue open about removing the private parameters (fastpath etc.) from the public interfaces, see #20110. Getting that done would be the proper solution to this problem, so I'm probably -1 on doing special preprocessing in sphinx etc. and IMO this specific doc issue be closed.

However, getting fastpath deprecated (and its functionality added in an internal class method) would be very nice and PRs in that direction would be welcome.

@topper-123 topper-123 added Constructors Series/DataFrame/Index/pd.array Constructors Closing Candidate May be closeable, needs more eyeballs and removed Needs Triage Issue that has not been reviewed by a pandas team member labels May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closing Candidate May be closeable, needs more eyeballs Constructors Series/DataFrame/Index/pd.array Constructors Docs Needs Discussion Requires discussion from core team before further action
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants