DOC: remove private parameters from method/constructor signatures #52019
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phofl
requested changes
Mar 16, 2023
|
@phofl thanks for the review. Is there any guide on how we do the deprecation? |
|
You should start by opening an issue to discuss it |
|
Created #52028 for the discussion. |
|
Seems like the issue needs more discussion before moving forward with a PR so closing for now, but we can reopen when theres more consensus |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.The documentation (e.g. for Series constructor) contain the parameters which are used only internally (fastpath in case of Series). Now if a parameter is private and prefixed with an underscore
_it will not be part of the signature in the output.