Skip to content

Commit a672412

Browse files
committed
tweaking the tutorial
1 parent 307ffa3 commit a672412

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/source/tutorial.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ The best way of getting information out from the calendar is to use the search.
145145
assert len(my_events) == 1
146146
print(my_events[0].data)
147147
148-
``expand`` causes the search results to be expanded. Instead of getting returned the original event (with ``DTSTART`` set in 2020 and an ``RRULE`` set) it will return a *recurrence*. Or, rather, a list of recurrences if there are more of them in the search interval.
148+
``expand`` matters for recurring events and tasks, instead of getting returned the original event (with ``DTSTART`` set in 2020 and an ``RRULE`` set) it will return a *recurrence*. Or, rather, a list of recurrences if there are more of them in the search interval.
149149

150150
``event`` causes the search to only return events. There are three kind of objects that can be saved to a calendar (but not all servers support all three) - events, journals and tasks (``VEVENT``, ``VJOURNAL`` and ``VTODO``). This is called Calendar Object Resources in the RFC (quite a mouthful! By now I often write "events" when in reality I mean "CalenderObjectResources objects, such as events or tasks", it's just easier). Without ``event=True`` explicitly set, in theory all the types should be returned - unfortunately many servers returns nothing. In future versions of CalDAV there will be workarounds so ``event=True`` can be safely skipped.
151151

0 commit comments

Comments
 (0)