Skip to content
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

DOC: Resolve RT03 errors for selected methods #57782

Merged
merged 9 commits into from
Mar 8, 2024

Conversation

bergnerjonas
Copy link
Contributor

@bergnerjonas bergnerjonas commented Mar 8, 2024

Resolve all RT03 errors for the following cases:

scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.expanding
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.filter
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.first_valid_index
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.last_valid_index
scripts/validate_docstrings.py --format=actions --errors=RT03 pandas.DataFrame.get

@bergnerjonas bergnerjonas changed the title Doc issue #57416 3 DOC: Resolve RT03 errors for selected methods, issue #57416 3 Mar 8, 2024
@bergnerjonas bergnerjonas changed the title DOC: Resolve RT03 errors for selected methods, issue #57416 3 DOC: Resolve RT03 errors for selected methods Mar 8, 2024
@bergnerjonas
Copy link
Contributor Author

Any idea why the unit tests / Numpy Dev failed? I only changed things in the docstrings not in the code itself.

pandas/core/generic.py Outdated Show resolved Hide resolved
pandas/core/generic.py Outdated Show resolved Hide resolved
@mroeschke mroeschke added the Docs label Mar 8, 2024
bergnerjonas and others added 3 commits March 8, 2024 22:41
Add default value to doc

Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
@mroeschke mroeschke added this to the 3.0 milestone Mar 8, 2024
@mroeschke mroeschke merged commit 1962c3f into pandas-dev:main Mar 8, 2024
47 checks passed
@mroeschke
Copy link
Member

Thanks @bergnerjonas

pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
* Add result information to  filter method.

* Add return information for first_valid_index method.

* Update docstring method for get method.

* Remove fixed methods from ignore list of check script

* Also remove last_valid_index from ignored method

* Fix docstring formatting.

* Update pandas/core/generic.py

Add default value to doc

Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>

* Update pandas/core/generic.py

Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>

* fix too long line in docstring.

---------

Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
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