Skip to content

Commit

Permalink
Merge pull request #676 from c0d33ngr/doc-update
Browse files Browse the repository at this point in the history
docs: replace pytz usage to zoneinfo in documentation
  • Loading branch information
niccokunzmann committed Jul 1, 2024
2 parents 4e218ed + fa04968 commit f101956
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Minor changes:
- Parallelize coverage
- Rename ``master`` branch to ``main``, see `Issue
<https://github.com/collective/icalendar/issues/627>`_
- Update ``docs/usage.rst`` to use zoneinfo instead of pytz.
- Added missing public classes and functions to API documentation.
- Improved namespace management in the ``icalendar`` directory.
- Add Python version badge and badge for test coverage
Expand Down
12 changes: 6 additions & 6 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -231,10 +231,10 @@ Property parameters are automatically added, depending on the input value. For
example, for date/time related properties, the value type and timezone
identifier (if applicable) are automatically added here::

>>> import pytz
>>> import zoneinfo
>>> event = Event()
>>> event.add('dtstart', datetime(2010, 10, 10, 10, 0, 0,
... tzinfo=pytz.timezone("Europe/Vienna")))
... tzinfo=zoneinfo.ZoneInfo("Europe/Vienna")))

>>> lines = event.to_ical().splitlines()
>>> assert (
Expand Down Expand Up @@ -262,7 +262,7 @@ Init the calendar::

>>> cal = Calendar()
>>> from datetime import datetime
>>> import pytz
>>> import zoneinfo

Some properties are required to be compliant::

Expand All @@ -273,9 +273,9 @@ We need at least one subcomponent for a calendar to be compliant::

>>> event = Event()
>>> event.add('summary', 'Python meeting about calendaring')
>>> event.add('dtstart', datetime(2005,4,4,8,0,0,tzinfo=pytz.utc))
>>> event.add('dtend', datetime(2005,4,4,10,0,0,tzinfo=pytz.utc))
>>> event.add('dtstamp', datetime(2005,4,4,0,10,0,tzinfo=pytz.utc))
>>> event.add('dtstart', datetime(2005,4,4,8,0,0,tzinfo=zoneinfo.ZoneInfo("UTC")))
>>> event.add('dtend', datetime(2005,4,4,10,0,0,tzinfo=zoneinfo.ZoneInfo("UTC")))
>>> event.add('dtstamp', datetime(2005,4,4,0,10,0,tzinfo=zoneinfo.ZoneInfo("UTC")))

A property with parameters. Notice that they are an attribute on the value::

Expand Down

0 comments on commit f101956

Please sign in to comment.