bpo-31327: Update time documentation to reflect possible errors (GH-3… · python/cpython@b35b36e (original) (raw)

Original file line number Diff line number Diff line change
@@ -259,6 +259,12 @@ Functions
259 259 :const:`None`, the current time as returned by :func:`.time` is used. The dst
260 260 flag is set to ``1`` when DST applies to the given time.
261 261
262 +:func:`localtime` may raise :exc:`OverflowError`, if the timestamp is
263 + outside the range of values supported by the platform C :c:func:`localtime`
264 + or :c:func:`gmtime` functions, and :exc:`OSError` on :c:func:`localtime` or
265 +:c:func:`gmtime` failure. It's common for this to be restricted to years
266 + between 1970 and 2038.
267 +
262 268
263 269 .. function:: mktime(t)
264 270