-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
Fix SS03 Issues in Docstrings #29315
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
Comments
I'll work on the bottom 10:
|
Afaik all the ones starting with |
Sorry for the delay @deepandas11 @datapythonista . Am I looking in the wrong place? Should I submit a preliminary PR and go from there? |
When changing |
I'll take the remaining 12.
|
Closing as a duplicate of #25306 |
Running the following:
scripts/validate_docstrings.py --errors=SS03
returns the following instances of cases where the Summary doesn't end with a period.
SS03 is one of the pending docstring-related errors as mentioned in #27977
The way to go about resolving this issue with such a large number of files has been nicely setup by @datapythonista in #27977 itself. Quoting from the issue:
> VERY IMPORTANT
The main challenge will be not repeating the same work as other sprinters, which is very frustrating, and happened massively at every sprint. My recommendation is BEFORE doing any work, to create an issue for the error code you plan to work on (check that it hasn't already been created). In the error write the list of errors that validate_docstrings.py returns. Then in a comment, take 10 of them, and write that you're going to fix them. Other people can work on a different 10. When opening a PR, reference the issue.
[UPDATE 1]
List has been updated after @datapythonista's recommendation to remove the ones starting with
pandas.tseries.offsets
.The text was updated successfully, but these errors were encountered: