Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
regebro committed May 31, 2023
1 parent 2bd083a commit e742b36
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ updates, but there will be no further functional changes on the 4.x branch.
Info
----

This Python module returns a ``tzinfo`` object (with a pytz_deprecation_shim,
for pytz compatibility) with the local timezone information, under Unix and
Windows.
This Python module returns a the `IANA time zone name
<https://www.iana.org/time-zones>`_ for your local time zone or a ``tzinfo``
object with the local timezone information, under Unix and Windows.

It requires Python 3.7 or later, and will use the ``backports.tzinfo``
package, for Python 3.7 and 3.8.
Expand All @@ -44,6 +44,16 @@ still not get to know what the timezone name is, but you don't need that when
you have the tzinfo file. However, if the timezone name is readily available
it will be used.

What it's not for
-----------------

It's not for converting the curfrent time betwee UTC and your local time. There are
other, simpler ways of doing this. This is of you need to know things like the name
of the time zone, or if you need to be able to convert between your time zone and
another time zone for times that are in the future or in the past.

For current time conversions to and from UTC, look in the python ``time`` module.


Supported systems
-----------------
Expand Down

0 comments on commit e742b36

Please sign in to comment.