Skip to content

fixed docstring error with pandas.Series.plot.area:Unknown parameter: {'stacked'} #48063

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

Merged

Conversation

joshuabello2550
Copy link
Contributor

When you run python ./scripts/validate_docstrings.py --errors=PR02, one of the errors is /home/pandas/pandas/plotting/_core.py:1470:PR02:pandas.Series.plot.area:Unknown parameters {'stacked'}

The error I believe is because "stacked" is declared in the docstring, but is not a parameter within the function. Even though stacked is only passed in when setting stacked to False, it should still be defined in the function parameter.

@joshuabello2550 joshuabello2550 changed the title fixed docstring error with pandas.Series.plot.area:Unknown parameters {'stacked'} fixed docstring error with pandas.Series.plot.area:Unknown parameter: {'stacked'} Aug 12, 2022
@joshuabello2550
Copy link
Contributor Author

Hi, I don't believe the changes I have made, contributed to the errors in the checks. Could you please clarify?

@mroeschke
Copy link
Member

Hi, I don't believe the changes I have made, contributed to the errors in the checks. Could you please clarify?

There are some related test failures: https://github.com/pandas-dev/pandas/runs/7811767621?check_suite_focus=true

@mroeschke mroeschke added the Visualization plotting label Aug 12, 2022
@joshuabello2550
Copy link
Contributor Author

Hi, I have tried to reproduce the test cases that are failing locally but could not. How can I go about debugging these errors?

@mroeschke
Copy link
Member

The issues look unrelated to this PR. Could you merge in main once more?

@phofl phofl merged commit c08c925 into pandas-dev:main Aug 26, 2022
@phofl phofl added this to the 1.5 milestone Aug 26, 2022
@phofl
Copy link
Member

phofl commented Aug 26, 2022

thx @joshuabello2550

noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants