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: Fix some RT02 issues in docstrings #50896

Merged
merged 2 commits into from
Jan 20, 2023

Conversation

DeaMariaLeon
Copy link
Member

@DeaMariaLeon DeaMariaLeon commented Jan 20, 2023

Towards #49968

Merge remote-tracking branch 'upstream/main' into docfinal
@mroeschke mroeschke added the Docs label Jan 20, 2023
@mroeschke mroeschke added this to the 2.0 milestone Jan 20, 2023
@mroeschke mroeschke merged commit 81bc66d into pandas-dev:main Jan 20, 2023
@mroeschke
Copy link
Member

Awesome good to see this fully enforced @DeaMariaLeon!

If interested in continuing with these validation there are other codes that we don't enforce https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks

( I would personally love to see EX01 enforced )

@DeaMariaLeon DeaMariaLeon deleted the docfinal branch January 20, 2023 18:04
@DeaMariaLeon
Copy link
Member Author

Thanks @mroeschke.

If interested in continuing with these validation there are other codes that we don't enforce https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks

( I would personally love to see EX01 enforced )

Yes, I'm interested. Would it be this issue? #37875

@mroeschke
Copy link
Member

Correct.

@MarcoGorelli
Copy link
Member

Yeah, exactly - even a PR to add something like

    MSG='Partially validate docstrings (EX01)' ; echo $MSG
    $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
	    <list of functions goes here>

(just like there was for RT02, until you fixed them all 🙌 ) would be really welcome

@DeaMariaLeon
Copy link
Member Author

Sure @MarcoGorelli I would be happy to help. Thanks for letting me know.

pooja-subramaniam pushed a commit to pooja-subramaniam/pandas that referenced this pull request Jan 25, 2023
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.

DOC: Fix RT02 issues in docstrings
3 participants