summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-12-27 09:36:17 (GMT)
committerGitHub <noreply@github.com>2023-12-27 09:36:17 (GMT)
commitfb02b6696002fc3dedbcf7c58aa40301650936ba (patch)
treefb62c7c54139927f4ca7f149a91697a785a8c1b8 /Doc
parent67655d8ad5de8666c97b0a377c6141a6abf66350 (diff)
downloadcpython-fb02b6696002fc3dedbcf7c58aa40301650936ba.zip
cpython-fb02b6696002fc3dedbcf7c58aa40301650936ba.tar.gz
cpython-fb02b6696002fc3dedbcf7c58aa40301650936ba.tar.bz2
gh-101100: Fix Sphinx warnings in `library/calendar.rst` (#113500)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/calendar.rst13
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 10 insertions, 4 deletions
diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
index 157a753..6586f53 100644
--- a/Doc/library/calendar.rst
+++ b/Doc/library/calendar.rst
@@ -196,6 +196,13 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is
output (defaulting to the system default encoding).
+ .. method:: formatmonthname(theyear, themonth, withyear=True)
+
+ Return a month name as an HTML table row. If *withyear* is true the year
+ will be included in the row, otherwise just the month name will be
+ used.
+
+
:class:`!HTMLCalendar` has the following attributes you can override to
customize the CSS classes used by the calendar:
@@ -289,7 +296,7 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is
.. note::
- The constructor, :meth:`formatweekday` and :meth:`formatmonthname` methods
+ The constructor, :meth:`!formatweekday` and :meth:`!formatmonthname` methods
of these two classes temporarily change the ``LC_TIME`` locale to the given
*locale*. Because the current locale is a process-wide setting, they are
not thread-safe.
@@ -358,7 +365,7 @@ For simple text calendars this module provides the following functions.
.. function:: month(theyear, themonth, w=0, l=0)
- Returns a month's calendar in a multi-line string using the :meth:`formatmonth`
+ Returns a month's calendar in a multi-line string using the :meth:`~TextCalendar.formatmonth`
of the :class:`TextCalendar` class.
@@ -370,7 +377,7 @@ For simple text calendars this module provides the following functions.
.. function:: calendar(year, w=2, l=1, c=6, m=3)
Returns a 3-column calendar for an entire year as a multi-line string using
- the :meth:`formatyear` of the :class:`TextCalendar` class.
+ the :meth:`~TextCalendar.formatyear` of the :class:`TextCalendar` class.
.. function:: timegm(tuple)
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index f2ffe85..88d479a 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -31,7 +31,6 @@ Doc/library/asyncio-policy.rst
Doc/library/asyncio-subprocess.rst
Doc/library/asyncio-task.rst
Doc/library/bdb.rst
-Doc/library/calendar.rst
Doc/library/cmd.rst
Doc/library/collections.rst
Doc/library/concurrent.futures.rst