-
-
Notifications
You must be signed in to change notification settings - Fork 17.9k
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 docstring validation errors for pandas.Timedelta/pandas.TimedeltaIndex #59698
Comments
take |
Working on --i "pandas.Timedelta.asm8 SA01" \ |
Hey @natmokval I tried running 'scripts/validate_docstrings.py pandas.Timedelta.ceil' command on my terminal. But I dont know why it doesnt execute. |
I would like to work on: -i "pandas.TimedeltaIndex.nanoseconds SA01" \ |
I'll work on these:
|
Hey @ivonastojanovic , could you please tell me how to solve this issue, I really want to be a contributor here but for some reason scripts/validate_docstrings.py command doesnt work. (I have tried to put different functions in place, if anyone could help me... :) |
Hey @doshi-kevin, when you run
At the bottom you see 2 errors, you shouldn't do anything about |
That's what the problem is, I forked the repo, kept it upstream and ran this command. |
Working on
|
sorry i forgot to mention on which methods i was working |
Working on
|
Working on
I installed a whole operating system for this :). |
I guess @uditbaliyan already completed this. |
@ammar-qazi If you have time, could you take |
Thank you, @amanlai. I'll take |
@ivonastojanovic I might have resolved the following in my commit for
That said, I'm not sure because there's no definitive docstring, as @amanlai already mentioned. Min, max, and resolution are probably attributes being defined by Alternatively, we can get the docs to show up after compilation by adding the docstring to timedeltas.pyi instead of timedeltas.pyx. However, I don't think that's the recommended way. |
working on #59914
|
Working on -i "pandas.Timedelta.components SA01" \ |
follow up on issues #56804, #59458 and #58063
pandas has a script for validating docstrings:
pandas/ci/code_checks.sh
Lines 112 to 128 in 2244402
Currently, some methods fail docstring validation check.
The task here is:
scripts/validate_docstrings.py <method-name>
pytest pandas/tests/scalar/test_nat.py::test_nat_doc_strings
code_checks.sh
scriptExample:
pandas.Timedelta.ceil fails with the SA01 and ES01 errors
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: