Skip to content

DOC: fix RT03 error for pandas.DataFrame.hist #56864

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

Closed
wants to merge 1 commit into from

Conversation

erichxchen
Copy link
Contributor

@erichxchen erichxchen commented Jan 14, 2024

Detected EX03 error for pandas.DataFrame.hist:

python scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.DataFrame.hist

Output:

################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.DataFrame.hist`:
        Return value has no description

The output after this changes:

################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.DataFrame.hist" correct. :)

@erichxchen erichxchen changed the title Fix EX03 error for pandas.DataFrame.hist Fix RT03 error for pandas.DataFrame.hist Jan 14, 2024
@erichxchen erichxchen changed the title Fix RT03 error for pandas.DataFrame.hist DOC: fix RT03 error for pandas.DataFrame.hist Jan 14, 2024
Comment on lines +231 to +232
An ndarray is returned with one :class:`matplotlib.AxesSubplot`
per column.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for fixing the style of the docstring @erichxchen.
I think think needs a bit more of work, as this doesn't seem very accurate. In general this will return the matplotlib object representing the histogram. This is what we should say first. Then, I'm not sure if an array is returned when by is used. Can you do some tests and make sure that what we provide here is relevant and correct please?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I will be working on this

Copy link
Contributor

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Feb 16, 2024
@datapythonista
Copy link
Member

This seems stale and conflicting, closing. Thanks for the work on this @erichxchen, if you have the time to finish this, or to work on other contributions, you're very welcome to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: fix EX03 errors in docstrings
2 participants