DOC: Remove RT03 docstring errors for selected methods #57797
Merged
Conversation
This file contains hidden or 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
added 6 commits
March 10, 2024 15:09
mroeschke
approved these changes
Mar 10, 2024
|
Thanks @bergnerjonas |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
) * Add return information on pop method. * Add return information on reindex method. * Add return information to reorder_levels method. * Add return information for to_numpy method. * Add return information to to_orc method. * Do not ignore fixed methods in code checks * Resolve docstring validation errors. * Fix errors in docstring * Fix link label * Fix label link
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.
Resolve all RT03 errors for the following cases:
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.pop
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.reindex
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.reorder_levels
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.swapaxes - deprecated in favor of .transpose, which already has valid docstring
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.to_numpy
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.to_orc
xref DOC: fix RT03 errors in docstrings DOC: fix RT03 errors in docstrings #57416
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.