Skip to content

DOC: updated docstrings for EX02 validation and updated code_checks #51724

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
merged 2 commits into from
Mar 2, 2023
Merged

DOC: updated docstrings for EX02 validation and updated code_checks #51724

merged 2 commits into from
Mar 2, 2023

Conversation

phershbe
Copy link
Contributor

@phershbe phershbe commented Mar 1, 2023

Closes an issue which was worked on by several people.

./ci/code_checks.sh docstrings is now passing completely with the Partially validate docstrings (EX02) section and its corresponding --ignore_functions list deleted and EX02 moved to the main Validate docstrings command.

pre-commit passes on the updated files.

@phershbe
Copy link
Contributor Author

phershbe commented Mar 1, 2023

@MarcoGorelli I feel pretty confident about the work here except for the What's new description. I put it in the 2.0.0 section, is that correct? I wanted to link to the main function in validate_docstrings.py, but I couldn't find it in the documentation. I added it to the Other enhancements section and wasn't sure if that was correct either. Also, obviously the other contributors and I should be listed in the What's new section, but it appears that the Contributors section will be filled out later.

Sorry for all of the questions, I'm asking them because the finishing of this issue represents the work of several other people as well and I wanted to make sure that things are correct.

@MarcoGorelli MarcoGorelli added this to the 2.1 milestone Mar 2, 2023
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Thanks @phershbe !

This doesn't need a whatsnew note as it's not user-facing

And yes, the contributors list will be populated automatically

@MarcoGorelli MarcoGorelli merged commit b056c63 into pandas-dev:main Mar 2, 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 EX02 errors in docstrings
2 participants