-
-
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 PR02 errors in docstrings #57111
Comments
I'll take
|
I'll get started with:
|
I'll take:
|
Would it be helpful to add the good-first-issue label to this? Seems the previous iteration (for EX03?) had that |
I think so, but I can't add the label myself. Feel free to add if you have permissions 🙂 |
/take |
I worked on:
|
I'll take
|
I'll work on
|
I got a fix for |
I'll take
|
got a fix for |
"Unknown parameters" arises from parameters in the docstring that do not appear in the function signatures. Often, this happens because the parameter is buried in In these cases, the only thing I can think of is to copy the default color value, adding it to the function signature (note this wouldn't be updated if What would be a better method? |
I've noticed this too, and I've been thinking about this a lot over the last week or so, but I'm not sure yet what the best approach would be. Whatever we end up choosing as the best approach, there are quite a few docstrings in the list that exhibit this behavior and could be resolved with the solution we decide on. |
As a suggestion, I've implemented something that might work in: #57235, open to suggestions on whether this reads well to people |
hi all, would like to get some opinions around the difficulty I'm having with the Currently, the offsets are generated using cython. Cython unfortunately does not support The I suspect there are libraries out there that would allow introspection of c objects and their signatures, is it alright to just import one of them? Alternatively I can go and look at whether we can expose this via tinkering with the Cython flags but that's new territory for me. [1] - https://cython.readthedocs.io/en/latest/src/userguide/limitations.html#inspect-support |
I got a fix for |
I got a fix for |
I'll open a PR for |
Im new to open source , apologies in advance when i run the command to check which methods fail the PR02 check even the methods that other people have dealt with and merged show up ? |
@Dxuian - try running this with some of the ones that haven't been fixed yet |
the checks fail for |
Ah I see, @Dxuian Running
which makes me think what might be going on is your branch might be out of sync with main. I've been using these commands to keep my env and branches in sync with the latest updates. Can you try updating your branch with the latest changes from main? Updating the development environment git checkout main git checkout main pre-commit install git checkout shiny-new-feature |
I got fixes for these:
|
so i've been trying to wrestle what going on wrong since yesterday but i cant seem to pin it down even after i've pulled from the latest main branch i still get the same PR02 errors on issues that should've been fixed after checking out this issue page. |
EDIT: this suggestion didn't end up panning out, I am going to close the PR. |
for anyone interested, I've opened some similar issues: |
Got fixes for |
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 72 to 194 in 9008ee5
Currently, some methods fail the PR02 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
thanks @natmokval @mroeschke for the inspiration for this issue
The text was updated successfully, but these errors were encountered: