Skip to content

DOC: fix docstring validation errors for pandas.PeriodIndex #59637

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

Closed
1 task done
hlakams opened this issue Aug 28, 2024 · 1 comment
Closed
1 task done

DOC: fix docstring validation errors for pandas.PeriodIndex #59637

hlakams opened this issue Aug 28, 2024 · 1 comment
Assignees
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@hlakams
Copy link
Contributor

hlakams commented Aug 28, 2024

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

pandas/ci/code_checks.sh

Lines 85 to 104 in ef3368a

-i "pandas.PeriodIndex.day_of_week SA01" \
-i "pandas.PeriodIndex.day_of_year SA01" \
-i "pandas.PeriodIndex.dayofweek SA01" \
-i "pandas.PeriodIndex.dayofyear SA01" \
-i "pandas.PeriodIndex.days_in_month SA01" \
-i "pandas.PeriodIndex.daysinmonth SA01" \
-i "pandas.PeriodIndex.from_fields PR07,SA01" \
-i "pandas.PeriodIndex.from_ordinals SA01" \
-i "pandas.PeriodIndex.hour SA01" \
-i "pandas.PeriodIndex.is_leap_year SA01" \
-i "pandas.PeriodIndex.minute SA01" \
-i "pandas.PeriodIndex.month SA01" \
-i "pandas.PeriodIndex.quarter SA01" \
-i "pandas.PeriodIndex.qyear GL08" \
-i "pandas.PeriodIndex.second SA01" \
-i "pandas.PeriodIndex.to_timestamp RT03,SA01" \
-i "pandas.PeriodIndex.week SA01" \
-i "pandas.PeriodIndex.weekday SA01" \
-i "pandas.PeriodIndex.weekofyear SA01" \
-i "pandas.PeriodIndex.year SA01" \

Documentation problem

pandas has GL08, PR07, RT03, and SA01 docstring validation issues in the pandas.PeriodIndex class.

Suggested fix for documentation

I am working on this issue and will have a fix out soon - opened here for clarity.

@hlakams hlakams added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Aug 28, 2024
@hlakams
Copy link
Contributor Author

hlakams commented Aug 28, 2024

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

No branches or pull requests

1 participant