details on weekday argument for DateOffset docs #54332
Conversation
|
Hey @Detoro . Can you try commenting |
|
pre-commit.ci autofix |
|
/preview |
|
No preview found for PR #54332. Did the docs build complete? |
There was a problem hiding this comment.
thanks for your PR
this addresses part of the issue - the other part is about the link
in See also, could you replace dateutil.relativedelta.relativedelta with https://dateutil.readthedocs.io/en/stable/relativedelta.html please?
thanks
pandas/_libs/tslibs/offsets.pyx
Outdated
| weekday : int {0, 1, ..., 6}, default 0 | ||
| A specific integer for the day of the week. | ||
| - 0 is Monday | ||
| - 1 is Tuesday | ||
| - 2 is Wednesday | ||
| - 3 is Thursday | ||
| - 4 is Friday | ||
| - 5 is Saturday | ||
| - 6 is Sunday. |
There was a problem hiding this comment.
this doesn't look quite right, you need a blank line before "A specific integer"
There was a problem hiding this comment.
Working with @Detoro on this - we'd like to view the built HTML but have been encountering some issues.
Namely, after running python make.py --single pandas.tseries.offsets.DateOffset in the doc directory, we don't see any output in directory reference/api for DateOffset. We're getting this warning from Sphinx:
/mnt/c/Users/batiu/OneDrive/Desktop/pandasContribution/pandas-toro/doc/source/index.rst:31: WARNING: autosummary references excluded document 'pandas.tseries.offsets.DateOffset'. Ignored.
Are we building this class correctly, and if so why is the class's documentation being excluded by "autosummary references"?
There was a problem hiding this comment.
@MarcoGorelli PR is updated, can you take another look? We'll squash the commits as well.
We were planning to do this in a follow up PR. Do you prefer if both parts are done in separate PRs, or a single PR? |
|
/preview |
|
No preview found for PR #54332. Did the docs build complete? |
|
pre-commit.ci autofix |
|
@mroeschke could you take a look? |
| @@ -1467,6 +1467,27 @@ class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta): | |||
| previous midnight. | |||
| **kwds | |||
| Temporal parameter that add to or replace the offset value. | |||
| weekday : int {0, 1, ..., 6}, default 0 | |||
There was a problem hiding this comment.
can this go before kwds? that should typically be the last argument
|
why did you close this? |
|
my bad @MarcoGorelli |
weekdayargument and has incorrect link forrelativedelta#52650