Skip to content

Commit 2a5cdb2

Browse files
authored
pythongh-85453: Improve variable mark up for datetime.rst (python#120702)
Variables and literals are marked up using backticks.
1 parent 3fea1d0 commit 2a5cdb2

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Doc/library/datetime.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -180,19 +180,19 @@ Objects of the :class:`date` type are always naive.
180180

181181
An object of type :class:`.time` or :class:`.datetime` may be aware or naive.
182182

183-
A :class:`.datetime` object *d* is aware if both of the following hold:
183+
A :class:`.datetime` object ``d`` is aware if both of the following hold:
184184

185185
1. ``d.tzinfo`` is not ``None``
186186
2. ``d.tzinfo.utcoffset(d)`` does not return ``None``
187187

188-
Otherwise, *d* is naive.
188+
Otherwise, ``d`` is naive.
189189

190-
A :class:`.time` object *t* is aware if both of the following hold:
190+
A :class:`.time` object ``t`` is aware if both of the following hold:
191191

192192
1. ``t.tzinfo`` is not ``None``
193193
2. ``t.tzinfo.utcoffset(None)`` does not return ``None``.
194194

195-
Otherwise, *t* is naive.
195+
Otherwise, ``t`` is naive.
196196

197197
The distinction between aware and naive doesn't apply to :class:`timedelta`
198198
objects.
@@ -358,8 +358,8 @@ Supported operations:
358358
+--------------------------------+-----------------------------------------------+
359359
| ``q, r = divmod(t1, t2)`` | Computes the quotient and the remainder: |
360360
| | ``q = t1 // t2`` (3) and ``r = t1 % t2``. |
361-
| | q is an integer and r is a :class:`timedelta` |
362-
| | object. |
361+
| | ``q`` is an integer and ``r`` is a |
362+
| | :class:`timedelta` object. |
363363
+--------------------------------+-----------------------------------------------+
364364
| ``+t1`` | Returns a :class:`timedelta` object with the |
365365
| | same value. (2) |
@@ -526,7 +526,7 @@ Other constructors, all class methods:
526526
January 1 of year 1 has ordinal 1.
527527

528528
:exc:`ValueError` is raised unless ``1 <= ordinal <=
529-
date.max.toordinal()``. For any date *d*,
529+
date.max.toordinal()``. For any date ``d``,
530530
``date.fromordinal(d.toordinal()) == d``.
531531

532532

@@ -730,7 +730,7 @@ Instance methods:
730730
.. method:: date.toordinal()
731731

732732
Return the proleptic Gregorian ordinal of the date, where January 1 of year 1
733-
has ordinal 1. For any :class:`date` object *d*,
733+
has ordinal 1. For any :class:`date` object ``d``,
734734
``date.fromordinal(d.toordinal()) == d``.
735735

736736

@@ -782,7 +782,7 @@ Instance methods:
782782

783783
.. method:: date.__str__()
784784

785-
For a date *d*, ``str(d)`` is equivalent to ``d.isoformat()``.
785+
For a date ``d``, ``str(d)`` is equivalent to ``d.isoformat()``.
786786

787787

788788
.. method:: date.ctime()
@@ -1063,7 +1063,7 @@ Other constructors, all class methods:
10631063
is used. If the *date* argument is a :class:`.datetime` object, its time components
10641064
and :attr:`.tzinfo` attributes are ignored.
10651065

1066-
For any :class:`.datetime` object *d*,
1066+
For any :class:`.datetime` object ``d``,
10671067
``d == datetime.combine(d.date(), d.time(), d.tzinfo)``.
10681068

10691069
.. versionchanged:: 3.6
@@ -1270,11 +1270,11 @@ Supported operations:
12701270

12711271
If both are naive, or both are aware and have the same :attr:`~.datetime.tzinfo` attribute,
12721272
the :attr:`~.datetime.tzinfo` attributes are ignored, and the result is a :class:`timedelta`
1273-
object *t* such that ``datetime2 + t == datetime1``. No time zone adjustments
1273+
object ``t`` such that ``datetime2 + t == datetime1``. No time zone adjustments
12741274
are done in this case.
12751275

12761276
If both are aware and have different :attr:`~.datetime.tzinfo` attributes, ``a-b`` acts
1277-
as if *a* and *b* were first converted to naive UTC datetimes. The
1277+
as if ``a`` and ``b`` were first converted to naive UTC datetimes. The
12781278
result is ``(a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None)
12791279
- b.utcoffset())`` except that the implementation never overflows.
12801280

@@ -1454,11 +1454,11 @@ Instance methods:
14541454

14551455
.. method:: datetime.utctimetuple()
14561456

1457-
If :class:`.datetime` instance *d* is naive, this is the same as
1457+
If :class:`.datetime` instance ``d`` is naive, this is the same as
14581458
``d.timetuple()`` except that :attr:`~.time.struct_time.tm_isdst` is forced to 0 regardless of what
14591459
``d.dst()`` returns. DST is never in effect for a UTC time.
14601460

1461-
If *d* is aware, *d* is normalized to UTC time, by subtracting
1461+
If ``d`` is aware, ``d`` is normalized to UTC time, by subtracting
14621462
``d.utcoffset()``, and a :class:`time.struct_time` for the
14631463
normalized time is returned. :attr:`!tm_isdst` is forced to 0. Note
14641464
that an :exc:`OverflowError` may be raised if ``d.year`` was
@@ -1606,7 +1606,7 @@ Instance methods:
16061606

16071607
.. method:: datetime.__str__()
16081608

1609-
For a :class:`.datetime` instance *d*, ``str(d)`` is equivalent to
1609+
For a :class:`.datetime` instance ``d``, ``str(d)`` is equivalent to
16101610
``d.isoformat(' ')``.
16111611

16121612

@@ -1853,7 +1853,7 @@ Instance attributes (read-only):
18531853
.. versionadded:: 3.6
18541854

18551855
:class:`.time` objects support equality and order comparisons,
1856-
where *a* is considered less than *b* when *a* precedes *b* in time.
1856+
where ``a`` is considered less than ``b`` when ``a`` precedes ``b`` in time.
18571857

18581858
Naive and aware :class:`!time` objects are never equal.
18591859
Order comparison between naive and aware :class:`!time` objects raises
@@ -2000,7 +2000,7 @@ Instance methods:
20002000

20012001
.. method:: time.__str__()
20022002

2003-
For a time *t*, ``str(t)`` is equivalent to ``t.isoformat()``.
2003+
For a time ``t``, ``str(t)`` is equivalent to ``t.isoformat()``.
20042004

20052005

20062006
.. method:: time.strftime(format)

0 commit comments

Comments
 (0)