traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue 5094: minor documentation fixes

This commit is contained in:
Alexander Belopolsky 2010-06-15 19:24:52 +00:00
parent 05cc2030e5
commit b39a0c242d
2 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Doc/library/datetime.rst
View File

@ -1351,7 +1351,7 @@ methods. Exactly which methods are needed depends on the uses made of aware
:mod:`datetime` objects. If in doubt, simply implement all of them. :mod:`datetime` objects. If in doubt, simply implement all of them.
.. method:: tzinfo.utcoffset(self, dt) .. method:: tzinfo.utcoffset(dt)
Return offset of local time from UTC, in minutes east of UTC. If local time is Return offset of local time from UTC, in minutes east of UTC. If local time is
west of UTC, this should be negative. Note that this is intended to be the west of UTC, this should be negative. Note that this is intended to be the
@ -1373,7 +1373,7 @@ methods. Exactly which methods are needed depends on the uses made of aware
:exc:`NotImplementedError`. :exc:`NotImplementedError`.
.. method:: tzinfo.dst(self, dt) .. method:: tzinfo.dst(dt)
Return the daylight saving time (DST) adjustment, in minutes east of UTC, or Return the daylight saving time (DST) adjustment, in minutes east of UTC, or
``None`` if DST information isn't known. Return ``timedelta(0)`` if DST is not ``None`` if DST information isn't known. Return ``timedelta(0)`` if DST is not
@ -1421,7 +1421,7 @@ methods. Exactly which methods are needed depends on the uses made of aware
The default implementation of :meth:`dst` raises :exc:`NotImplementedError`. The default implementation of :meth:`dst` raises :exc:`NotImplementedError`.
.. method:: tzinfo.tzname(self, dt) .. method:: tzinfo.tzname(dt)
Return the time zone name corresponding to the :class:`datetime` object *dt*, as Return the time zone name corresponding to the :class:`datetime` object *dt*, as
a string. Nothing about string names is defined by the :mod:`datetime` module, a string. Nothing about string names is defined by the :mod:`datetime` module,
@ -1457,7 +1457,7 @@ time, and not need worry about objects in other timezones.
There is one more :class:`tzinfo` method that a subclass may wish to override: There is one more :class:`tzinfo` method that a subclass may wish to override:
.. method:: tzinfo.fromutc(self, dt) .. method:: tzinfo.fromutc(dt)
This is called from the default :class:`datetime.astimezone()` implementation. This is called from the default :class:`datetime.astimezone()` implementation.
When called from that, ``dt.tzinfo`` is *self*, and *dt*'s date and time members When called from that, ``dt.tzinfo`` is *self*, and *dt*'s date and time members
@ -1553,46 +1553,46 @@ changes have been made to civil time.
.. class:: timezone(offset[, name]) .. class:: timezone(offset[, name])
The ``offset`` argument must be specified as a :class:`timedelta` The *offset* argument must be specified as a :class:`timedelta`
object representing the difference between the local time and UTC. It must object representing the difference between the local time and UTC. It must
be within the range [``-timedelta(hours=23, minutes=59), be strictly between ``-timedelta(hours=24)`` and
``timedelta(hours=23, minutes=59)``] and represent whole number of minutes, ``timedelta(hours=24)`` and represent a whole number of minutes,
otherwise :exc:`ValueError` is raised. otherwise :exc:`ValueError` is raised.
The ``name`` argument is optional. If specified it must be a string that The *name* argument is optional. If specified it must be a string that
used as the value returned by the ``tzname(dt)`` method. Otherwise, is used as the value returned by the ``tzname(dt)`` method. Otherwise,
``tzname(dt)`` returns a string 'UTCsHH:MM', where s is the sign of ``tzname(dt)`` returns a string 'UTCsHH:MM', where s is the sign of
``offset``, HH and MM are two digits of ``offset.hours`` and *offset*, HH and MM are two digits of ``offset.hours`` and
``offset.minutes`` respectively. ``offset.minutes`` respectively.
.. method:: timezone.utcoffset(self, dt) .. method:: timezone.utcoffset(dt)
Returns the fixed value specified when the :class:`timezone` instance is Return the fixed value specified when the :class:`timezone` instance is
constructed. The ``dt`` argument is ignored. The return value is a constructed. The *dt* argument is ignored. The return value is a
:class:`timedelta` instance equal to the difference between the :class:`timedelta` instance equal to the difference between the
local time and UTC. local time and UTC.
.. method:: timezone.tzname(self, dt) .. method:: timezone.tzname(dt)
Returns the fixed value specified when the :class:`timezone` instance is Return the fixed value specified when the :class:`timezone` instance is
constructed or a string 'UTCsHH:MM', where s is the sign of constructed or a string 'UTCsHH:MM', where s is the sign of
``offset``, HH and MM are two digits of ``offset.hours`` and *offset*, HH and MM are two digits of ``offset.hours`` and
``offset.minutes`` respectively. The ``dt`` argument is ignored. ``offset.minutes`` respectively.
.. method:: timezone.dst(self, dt) .. method:: timezone.dst(dt)
Always returns ``None``. Always returns ``None``.
.. method:: timezone.fromutc(self, dt) .. method:: timezone.fromutc(dt)
Returns ``dt + offset``. The ``dt`` argument must be aware with ``tzinfo`` Return ``dt + offset``. The *dt* argument must be an aware
set to ``self``. :class:`datetime` instance, with ``tzinfo`` set to ``self``.
Class attributes: Class attributes:
.. attribute:: timezone.utc .. attribute:: timezone.utc
The UTC timezone, ``timezone(0, 'UTC')``. The UTC timezone, ``timezone(timedelta(0))``.
.. _strftime-strptime-behavior: .. _strftime-strptime-behavior:

6
Modules/datetimemodule.c
View File

@ -3472,13 +3472,13 @@ timezone_fromutc(PyDateTime_TimeZone *self, PyDateTime_DateTime *dt)
static PyMethodDef timezone_methods[] = { static PyMethodDef timezone_methods[] = {
{"tzname", (PyCFunction)timezone_tzname, METH_O, {"tzname", (PyCFunction)timezone_tzname, METH_O,
PyDoc_STR("If name is specified when timezone is created, returns the name." PyDoc_STR("If name is specified when timezone is created, returns the name."
" Otherwise returns offset as 'UTC(+|-)HHMM'.")}, " Otherwise returns offset as 'UTC(+|-)HH:MM'.")},
{"utcoffset", (PyCFunction)timezone_utcoffset, METH_O, {"utcoffset", (PyCFunction)timezone_utcoffset, METH_O,
PyDoc_STR("Returns fixed offset. Ignores its argument.")}, PyDoc_STR("Return fixed offset.")},
{"dst", (PyCFunction)timezone_dst, METH_O, {"dst", (PyCFunction)timezone_dst, METH_O,
PyDoc_STR("Returns None. Ignores its argument.")}, PyDoc_STR("Return None.")},
{"fromutc", (PyCFunction)timezone_fromutc, METH_O, {"fromutc", (PyCFunction)timezone_fromutc, METH_O,
PyDoc_STR("datetime in UTC -> datetime in local time.")}, PyDoc_STR("datetime in UTC -> datetime in local time.")},