Skip to content

gh-108202: calendar: Document prweek #108466

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

gh-108202: calendar: Document prweek #108466

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2aabadf
Document TextCalendar prweek and mdays attribute
Aug 25, 2023
ef61b8c
Documented TextCalendar methods
apurvakhatri Aug 30, 2023
c012f5e
Documented TextCalendar prweek
apurvakhatri Aug 30, 2023
ef3b639
Merge branch 'main' into fix-issue-108202
hugovk Aug 15, 2024
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
5 changes: 5 additions & 0 deletions Doc/library/calendar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,11 @@

:class:`TextCalendar` instances have the following methods:

.. method:: prweek(theweek, width)

Print a week's calendar as returned by :meth:`formatweek` and sets the

Check warning on line 143 in Doc/library/calendar.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:meth reference target not found: formatweek [ref.meth]
Copy link
Member

Choose a reason for hiding this comment

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

This will silence the warning (it can be reverted when the formatweek documentation is added):

Suggested change
Print a week's calendar as returned by :meth:`formatweek` and sets the
Print a week's calendar as returned by :meth:`!formatweek` and sets the

end parameter to an empty string to prevent adding a newline character.

.. method:: formatmonth(theyear, themonth, w=0, l=0)

Return a month's calendar in a multi-line string. If *w* is provided, it
Expand Down
Loading