Skip to content

DOC: DateOffset docs missing details on weekday argument and has incorrect link for relativedelta #52650

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

Open
1 task done
Dr-Irv opened this issue Apr 13, 2023 · 2 comments
Open
1 task done
Assignees
Labels

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Apr 13, 2023

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

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.tseries.offsets.DateOffset.html

Documentation problem

First, the weekday argument has a type that comes from relativedelta that is class weekday

Second, the link to dateutil.relativedelta.relativedelta is going to matplotlib, but it really should go to dateutil: https://dateutil.readthedocs.io/en/stable/relativedelta.html

Suggested fix for documentation

  1. Fix the link to go to the relativedelta docs, not matplotlib
  2. Document that weekday has a special type for its argument.
@TeoSkondras
Copy link

take

@TeoSkondras TeoSkondras removed their assignment Apr 21, 2023
@phofl phofl removed the Needs Triage Issue that has not been reviewed by a pandas team member label Apr 22, 2023
@Detoro
Copy link
Contributor

Detoro commented Jul 21, 2023

take

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

No branches or pull requests

4 participants