Skip to content

Enhanced the documentation and added examples in pandas tseries offsets Week class #50732

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.

Sign up for GitHub

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

Merged
merged 15 commits into from
Jan 17, 2023
Merged

Enhanced the documentation and added examples in pandas tseries offsets Week class #50732

Changes from 10 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f8c5d5d
Enhanced the documentation and added examples in ts offsets Week class
akshay-babbar Jan 13, 2023
6c8648b
Fixed indentation and examples in docs
akshay-babbar Jan 13, 2023
4f23831
Removed pd import from docs
akshay-babbar Jan 13, 2023
b1c6110
Remove extra line breaks in doc strings
akshay-babbar Jan 13, 2023
de464ec
Remove extra line breaks in doc strings-v1
akshay-babbar Jan 13, 2023
9a493e9
Remove extra line breaks in doc strings-v2
akshay-babbar Jan 13, 2023
7e3afa3
Added extended summary and see also section
akshay-babbar Jan 13, 2023
e99a1ec
Added extended summary and see also section-v1
akshay-babbar Jan 13, 2023
9eb2f2e
Merge branch 'main' into offsets-week-doc
akshay-babbar Jan 13, 2023
f68b9f8
Removed extender summary, small cased var names and used pd.Timestamp
akshay-babbar Jan 13, 2023
02f7fda
Added line space
akshay-babbar Jan 13, 2023
0ea315d
Merge branch 'main' into offsets-week-doc
akshay-babbar Jan 16, 2023
e7282a7
Fixed long lines and some print statements
akshay-babbar Jan 16, 2023
17d8965
Fixed long lines and some print statements-v1
akshay-babbar Jan 16, 2023
40a2882
Merge branch 'main' into offsets-week-doc
MarcoGorelli Jan 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2778,17 +2778,33 @@ cdef class SemiMonthBegin(SemiMonthOffset):
cdef class Week(SingleConstructorOffset):
"""
Weekly offset.

Parameters
----------
weekday : int or None, default None
Always generate specific day of week. 0 for Monday.
Always generate specific day of week. 0 for Monday and 6 for Sunday.

Examples
See Also
--------
>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts + pd.offsets.Week()
Timestamp('2022-01-08 00:00:00')
pd.tseries.offsets.WeekOfMonth : Describes monthly dates like "the Tuesday of the 2nd week of each month".

Examples
---------
Comment on lines +2794 to +2795
Copy link
Member

Choose a reason for hiding this comment

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

just noticed, I think the underscores need to be the same length as the title

could you please also build this docstring locally and screenshot it and check it looks alright?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

Hi @MarcoGorelli, it looks like this. It looks fine to me :D but should i add one more commit?

Copy link
Member

@MarcoGorelli MarcoGorelli Jan 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

that's not the rendered docstring, see https://pandas.pydata.org/docs/dev/development/contributing_documentation.html#building-the-documentation for how to build it

something like

cd doc
python make.py clean && python make.py --single pandas.tseries.offsets.Week

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

Hey @MarcoGorelli , this is the rendered docstring, does this work?


>>> date_object = pd.Timestamp("2023-01-13")
>>> date_object
2023-01-13 00:00:00

>>> date_plus_one_week = date_object + pd.tseries.offsets.Week(n=1)
>>> date_plus_one_week
2023-01-20 00:00:00

>>> date_next_monday = date_object + pd.tseries.offsets.Week(weekday=0)
>>> date_next_monday
2023-01-16 00:00:00

>>> date_next_sunday = date_object + pd.tseries.offsets.Week(weekday=6)
>>> date_next_sunday
2023-01-15 00:00:00
"""

_inc = timedelta(weeks=1)
Expand Down