-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Fix format of the See Also descriptions #23630
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 will try and do this one. |
@syutbai I'm not sure how it can take to fix all them. If you feel there are too many, feel free to send a pull request fixing just part of them. |
I also edited "See also" --> "See Also" along the way. I reduced it to the following:
|
Great job. We had another issue to fix the |
Hi, can I take a stab at fixing the remaining errors? |
sure, go ahead |
Hey, is this still open? Sort of new to this. I'd like to try my hand at fixing this. |
I just ran the script on those errors today and didn't find any. Are we safe to close this issue? |
Sure, but add the validation of this error to the CI then (see |
Our standard for the
See Also
section is:In many cases, for historical reasons, the format of the description does not start with a capital and does not finish with a period. We should fix those.
The next command shows all the cases that are wrong and should be fixed. Note that as
Panel
will be removed soon, is better to not waste time fixing their docstrings (see the grep).When calling
validate_docstrings.py
, an argument--format=azure
(or--format=json
) and the output will contain the name of the file with the source code, and the line, where the function is defined. It won't always be correct, as introspection in Python is not perfect when the code is tricky, but it can be useful in many cases.The text was updated successfully, but these errors were encountered: