Skip to content

Conversation

deepith-18
Copy link

@deepith-18 deepith-18 commented Sep 15, 2025

This PR adds a missing period to the numeric_only parameter in the DataFrame.count docstring, improving documentation consistency.

[x] xref #58063 (addresses one small part of the parent issue)

[x] All code checks passed.

@simonjayhawkins
Copy link
Member

Thanks @deepith-18 for the PR

if the PR only addresses a part and does not close the linked issue, please use xref instead of closes otherwise merging this PR will automatically close the linked issue.

@deepith-18
Copy link
Author

Thanks @deepith-18 for the PR

if the PR only addresses a part and does not close the linked issue, please use xref instead of closes otherwise merging this PR will automatically close the linked issue.

Thanks for the great feedback, @simonjayhawkins! I have updated the PR description to use xref instead of closes to correctly reference the parent issue, as you suggested. Please let me know if any other changes are needed.

If 0 or 'index' counts are generated for each column.
If 1 or 'columns' counts are generated for each row.
numeric_only : bool, default False
numeric_only : bool, default False.
Copy link
Member

Choose a reason for hiding this comment

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

the ci is reporting

Error: /home/runner/work/pandas/pandas/pandas/core/frame.py:11766:PR05:pandas.DataFrame.count:Parameter "numeric_only" type should not finish with "."

So the periods that need to be added are for the longer descriptions

What were the errors reported by

scripts/validate_docstrings.py --format=actions

that this PR is fixing?

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the detailed feedback and clarification, @simonjayhawkins! My apologies, I added the period to the wrong line. I've now moved it to the end of the longer description as you suggested.

@deepith-18 deepith-18 force-pushed the doc-fix-frame-periods branch from 9420b7c to 3b71240 Compare September 16, 2025 14:12
@simonjayhawkins
Copy link
Member

This PR adds a missing period to the numeric_only parameter in the DataFrame.count docstring, improving documentation consistency.

if you do on main

scripts/validate_docstrings.py --format=actions pandas.DataFrame.count

you get

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

so closing this one. Please feel free to take another method listed in #58063

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.

2 participants