Commit f40b4a0b authored by Yasser A's avatar Yasser A Committed by Nick Coghlan

bpo-36138: Clarify docs about converting datetime.timedelta to scalars. (GH-12137)

Be explicit that timedelta division converts an overall duration to the interval
units given by the denominator.
parent d2fdd1fe
......@@ -254,8 +254,9 @@ Supported operations:
| | rounded to the nearest multiple of |
| | timedelta.resolution using round-half-to-even.|
+--------------------------------+-----------------------------------------------+
| ``f = t2 / t3`` | Division (3) of *t2* by *t3*. Returns a |
| | :class:`float` object. |
| ``f = t2 / t3`` | Division (3) of overall duration *t2* by |
| | interval unit *t3*. Returns a :class:`float` |
| | object. |
+--------------------------------+-----------------------------------------------+
| ``t1 = t2 / f or t1 = t2 / i`` | Delta divided by a float or an int. The result|
| | is rounded to the nearest multiple of |
......@@ -351,7 +352,8 @@ Instance methods:
.. method:: timedelta.total_seconds()
Return the total number of seconds contained in the duration. Equivalent to
``td / timedelta(seconds=1)``.
``td / timedelta(seconds=1)``. For interval units other than seconds, use the
division form directly (e.g. ``td / timedelta(microseconds=1)``).
Note that for very large time intervals (greater than 270 years on
most platforms) this method will lose microsecond accuracy.
......
Improve documentation about converting datetime.timedelta to scalars.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment