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.
This commit is contained in:
Walter Dörwald 2008-02-07 19:30:22 +00:00
parent 86371d61b7
commit 97bf449f75
1 changed files with 10 additions and 8 deletions

View File

@ -117,9 +117,10 @@ it's the base calendar for all computations.
.. method:: TextCalendar.formatmonth(theyear, themonth[, w[, l]]) .. method:: TextCalendar.formatmonth(theyear, themonth[, w[, l]])
Return a month's calendar in a multi-line string. If *w* is provided, it 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 width of the date columns, which are centered. If *l* is given,
specifies the number of lines that each week will use. Depends on the first it specifies the number of lines that each week will use. Depends on the
weekday as set by :func:`setfirstweekday`. first weekday as specified in the constructor or set by the
:meth:`setfirstweekday` method.
.. method:: TextCalendar.prmonth(theyear, themonth[, w[, l]]) .. 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]]]]) .. method:: TextCalendar.formatyear(theyear, themonth[, w[, l[, c[, m]]]])
Return a *m*-column calendar for an entire year as a multi-line string. Optional Return a *m*-column calendar for an entire year as a multi-line string.
parameters *w*, *l*, and *c* are for date column width, lines per week, and Optional parameters *w*, *l*, and *c* are for date column width, lines per
number of spaces between month columns, respectively. Depends on the first week, and number of spaces between month columns, respectively. Depends on
weekday as set by :meth:`setfirstweekday`. The earliest year for which a the first weekday as specified in the constructor or set by the
calendar can be generated is platform-dependent. :meth:`setfirstweekday` method. The earliest year for which a calendar can
be generated is platform-dependent.
.. method:: TextCalendar.pryear(theyear[, w[, l[, c[, m]]]]) .. method:: TextCalendar.pryear(theyear[, w[, l[, c[, m]]]])