details on weekday argument for DateOffset docs #54332
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1373,6 +1373,24 @@ 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 | ||
| 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.
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. |
||
|
|
||
| Instead Weekday type from dateutil.relativedelta can be used. | ||
| - MO is Monday | ||
| - TU is Tuesday | ||
| - WE is Wednesday | ||
| - TH is Thursday | ||
| - FR is Friday | ||
| - SA is Saturday | ||
| - SU is Sunday. | ||
|
|
||
| Parameters that **add** to the offset (like Timedelta): | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can this go before
kwds? that should typically be the last argumentThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.