DOC: fix pr02 errors in docstrings - plot.bar, plot.barh, plot.line, plot.pie #57266
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
mroeschke
reviewed
Feb 7, 2024
| ) -> PlotAccessor: | ||
| """ | ||
| Plot Series or DataFrame as lines. | ||
|
|
||
| This function is useful to plot lines using DataFrame's values | ||
| as coordinates. | ||
| """ | ||
| if color is not None: |
There was a problem hiding this comment.
Instead can you just specify return self(..., color=color, **kwargs)? (and likewise below)
There was a problem hiding this comment.
This would be prettier, but calling self(..., color=None, colormap=foo) raises UserWarnings for simultaneous usage of conflicting args, and the function defaults to use color=None, ignoring the value of colormap.
Similar situation for y in the pieplot, which conflicts with the usage of subplots depending on their respective values.
mroeschke
approved these changes
Feb 7, 2024
|
Thanks @noah-asing |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
…plot.pie (pandas-dev#57266) * bring "color" out of kwargs in bar,barh,line function signatures to match docstring * bring "y" out of kwargs in pie function signatures to match docstring * update code_checks for fixed docstrings * change typehint from np Arraylike to Sequence to avoid dependence on np typing * Use "IndexLabel" instead of generics * rebundle args into kwargs before calling self to avoid "cannot use foo arg with bar arg" errors
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.
Methods for
pandas.Series.plot.barandpandas.DataFrame.plot.barhave the same underlying usage ofPlotAccessor.validate_docstrings script output
1a. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.plot.bar
1b. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.DataFrame.plot.bar
2a. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.plot.barh
2b. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.DataFrame.plot.barh
3a. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.plot.line
3b. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.DataFrame.plot.line
4a. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.plot.pie
################################################################################
################################## Validation ##################################
################################################################################
Docstring for "pandas.DataFrame.plot.pie" correct. :)
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.