Skip to content
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 Timedelta attributes (min, max, resolution) d… #60486

Open
wants to merge 30 commits into
base: main
Choose a base branch
from

Conversation

brownl83
Copy link

@brownl83 brownl83 commented Dec 3, 2024

Part of #59698

Addresses:

pandas.Timedelta

Added the missing explanations (PRO2) for min, max, and resolution.

Removed from code_checks.sh

i "pandas.Timedelta.resolution PR02"
i "pandas.Timedelta.min PR02"
i "pandas.Timedelta.resolution PR02" \

@MarcoGorelli
Copy link
Member

thanks for your pr, looks like there's some issues

/home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpydoc/docscrape.py:203: UserWarning: potentially wrong underline length... 
Returns 
-------- in 

Return utc offset.... in the docstring of utcoffset
  while not self._is_at_section() and not self._doc.eof():
/home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpydoc/docscrape.py:203: UserWarning: potentially wrong underline length... 
Examples 
------------ in 

Check whether all characters in each string are titlecase.... in the docstring of istitle in /home/runner/work/pandas/pandas/pandas/core/strings/accessor.py.
  while not self._is_at_section() and not self._doc.eof():
Error: None:None:PR02:pandas.Timedelta.max:Unknown parameters {'value', 'unit', '**kwargs'}
Error: None:None:PR02:pandas.Timedelta.min:Unknown parameters {'value', 'unit', '**kwargs'}
Error: None:None:PR02:pandas.Timedelta.resolution:Unknown parameters {'value', 'unit', '**kwargs'}

@brownl83
Copy link
Author

brownl83 commented Dec 4, 2024

I will take any suggestions on how to deal with those unknown parameters, as I have exhausted all possible ideas. I am not sure that the min, max, and Resolution are good to be tagged with the "good first issue".

@brownl83
Copy link
Author

brownl83 commented Dec 4, 2024

Can the ignores be left in code_checks.sh and still have it update the documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants