DOC: Fixed all remaining GL02 documentation errors and added appropriate check in CI #43003
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Contributor
fshi01 commented Aug 12, 2021
fshi01 commented - Closes DOC: Fixed GL02 errors in documentation #42809
- Adds check for GL02 in CI
Contributor
| there is a precommit failure |
Contributor Author
| The pre-commit error is now fixed. The remaining errors stem from test_nat_doc_strings, which tests overlapping methods for matching docstrings. In order to fix the remaining GL02 docstring errors, I had to overwrite the docstring for two methods from the parent class. In order to fix these two errors, the docstrings will not match. How should I proceed? |
Contributor
| right you will have to add these same methods to NaT (possibly adjusting the text) |
MarcoGorelli approved these changes Aug 17, 2021
Member
MarcoGorelli left a comment
MarcoGorelli left a comment There was a problem hiding this comment.
As far I can tell, the issue is that the docstring from datetime doesn't conform to the requirements? If so, this looks good to me
Contributor
| thanks @fshi01 very nice! |
feefladder pushed a commit to feefladder/pandas that referenced this pull request Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.