diff options
| author | Walter Dörwald <walter@livinglogic.de> | 2008-02-07 19:30:22 (GMT) |
|---|---|---|
| committer | Walter Dörwald <walter@livinglogic.de> | 2008-02-07 19:30:22 (GMT) |
| commit | 97bf449f756effcbfd0c87d5840cdeab5139fb39 (patch) | |
| tree | 7b887f20f70c5fc67325ac2c886d8e0a6be3c0f4 /Doc/library/calendar.rst | |
| parent | 86371d61b704958e68bed0f9937c6a1ff5fd766e (diff) | |
| download | cpython-97bf449f756effcbfd0c87d5840cdeab5139fb39.zip cpython-97bf449f756effcbfd0c87d5840cdeab5139fb39.tar.gz cpython-97bf449f756effcbfd0c87d5840cdeab5139fb39.tar.bz2 | |
Clarify that the output of TextCalendar.formatmonth() and
TextCalendar.formatyear() for custom instances won't be influenced by calls
to the module global setfirstweekday() function. Fixes #2018.
Diffstat (limited to 'Doc/library/calendar.rst')
| -rw-r--r-- | Doc/library/calendar.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst index fc1f399..364ce2a 100644 --- a/Doc/library/calendar.rst +++ b/Doc/library/calendar.rst @@ -117,9 +117,10 @@ it's the base calendar for all computations. .. method:: TextCalendar.formatmonth(theyear, themonth[, w[, l]]) Return a month's calendar in a multi-line string. If *w* is provided, it - specifies the width of the date columns, which are centered. If *l* is given, it - specifies the number of lines that each week will use. Depends on the first - weekday as set by :func:`setfirstweekday`. + specifies the width of the date columns, which are centered. If *l* is given, + it specifies the number of lines that each week will use. Depends on the + first weekday as specified in the constructor or set by the + :meth:`setfirstweekday` method. .. method:: TextCalendar.prmonth(theyear, themonth[, w[, l]]) @@ -129,11 +130,12 @@ it's the base calendar for all computations. .. method:: TextCalendar.formatyear(theyear, themonth[, w[, l[, c[, m]]]]) - Return a *m*-column calendar for an entire year as a multi-line string. Optional - parameters *w*, *l*, and *c* are for date column width, lines per week, and - number of spaces between month columns, respectively. Depends on the first - weekday as set by :meth:`setfirstweekday`. The earliest year for which a - calendar can be generated is platform-dependent. + Return a *m*-column calendar for an entire year as a multi-line string. + Optional parameters *w*, *l*, and *c* are for date column width, lines per + week, and number of spaces between month columns, respectively. Depends on + the first weekday as specified in the constructor or set by the + :meth:`setfirstweekday` method. The earliest year for which a calendar can + be generated is platform-dependent. .. method:: TextCalendar.pryear(theyear[, w[, l[, c[, m]]]]) |