-
-
Notifications
You must be signed in to change notification settings - Fork 18.1k
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 GL08 errors in docstrings #57443
Comments
I don't have permission to add them, but this could probably use some labels:
|
addresses #57360 |
take |
working on |
working on |
Opened a fix for
|
Working on |
Working on |
Opened a fix for |
working on
|
I am not able to find the proper location.Can anyone help me? I was trying to add docstring for pandas.Period.freq but I am still getting the error " The object does not have a docstring |
@pmhatre1 I've had the same experience. I could not locate the correct function to add the docstring to. I've encountered this before, and my suspicion is this is something defined in |
Take pandas.Series.dt.freq\ |
I think you are right @jordan-d-murphy. Can we pull in someone here to help us? |
I would love to hear some ideas from folks that might have suggestions on how to do this. @jrmylow talks about this under [DOC: fix PR02 errors in docstrings](#57111) in this comment here #57111 (comment) maybe we can pursue this? |
Hi all, if CI: speedup docstring check consecutive runs #57826 gets merged in, I might be reworking our approach here; this would look like closing the following issues:
And opening a new issue to address these based on the new approach. tl;dr the work can still be done, but probably under a new ticket once #57826 is merged in |
Closed by: Opening a new issue to fix docstring errors. |
Opened DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063 as a parent issue for fixing docstrings based on the refactoring in code_checks.sh Feel free to swing by and help out! 🙂 |
Pandas has a script for validating docstrings:
pandas/ci/code_checks.sh
Lines 144 to 415 in 92a52e2
Currently, some methods fail the GL08 check.
The task here is:
method-name
Please don't comment take as multiple people can work on this issue. You also don't need to ask for permission to work on this, just comment on which methods are you going to work.
If you're new contributor, please check the contributing guide
The text was updated successfully, but these errors were encountered: