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: fixing GL08 errors for pandas.Series.dt #57751

Merged
merged 11 commits into from
Mar 17, 2024
Merged

DOC: fixing GL08 errors for pandas.Series.dt #57751

merged 11 commits into from
Mar 17, 2024

Conversation

s1099
Copy link
Contributor

@s1099 s1099 commented Mar 6, 2024

Resolved GL08 error for scripts/validate_docstrings.py --format=actions --errors=GL08 pandas.Series.dt
xref: #57443

@s1099
Copy link
Contributor Author

s1099 commented Mar 6, 2024

pre-commit.ci autofix

@s1099 s1099 requested a review from mroeschke as a code owner March 7, 2024 09:44
@datapythonista
Copy link
Member

I'm missing something. Series.dt seems to already have a docstring: https://pandas.pydata.org/docs/reference/api/pandas.Series.dt.html#pandas-series-dt

You seem to be modifying the one for Index. It would be good to use the Series.dt as reference, the Parameters and Returns section don't make sense to me for an accessor.

pandas/core/indexes/accessors.py Outdated Show resolved Hide resolved
pandas/core/indexes/accessors.py Outdated Show resolved Hide resolved
pandas/core/indexes/accessors.py Outdated Show resolved Hide resolved
@datapythonista
Copy link
Member

/preview

Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/57751/

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update @s1099, looks good now. Just two minor things more if you don't mind.

ci/code_checks.sh Outdated Show resolved Hide resolved
pandas/core/indexes/accessors.py Outdated Show resolved Hide resolved
s1099 and others added 2 commits March 17, 2024 03:15
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @s1099, looks great.

@mroeschke mroeschke added this to the 3.0 milestone Mar 17, 2024
@mroeschke mroeschke merged commit 9eb1553 into pandas-dev:main Mar 17, 2024
46 of 47 checks passed
@mroeschke
Copy link
Member

Thanks @s1099

pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
* fix GL08 error and write docstring for pandas.Series.dt

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update docstring with parameters

* format docstring and remove from validate docstring ignore

* Remove parameters, returns and add reference

* remove Raises, Notes and update description

* make it pass ci checks

* update see also

* Update ci/code_checks.sh

Co-authored-by: Marc Garcia <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Marc Garcia <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants