Skip to content

docs: recurring-task completion is "not yet"; native after a write on CalDAV - #37

Open
JaroAI777 wants to merge 2 commits into
PyCalendar:mainfrom
JaroAI777:docs-complete-recurring
Open

JaroAI777 wants to merge 2 commits into
PyCalendar:mainfrom
JaroAI777:docs-complete-recurring

Conversation

@JaroAI777

Copy link
Copy Markdown

Docs only, following #29 and the decision in API_DESIGN Q3 (2026-10-23) that recurring-task completion goes to edit-icalendar (edit-icalendar#3).

  • §3.7: complete() on a task with an RRULE raises UnsupportedError until edit-icalendar has it; link to edit-icalendar#3; the CalDAV escape hatch in the meantime (read the task, task.native.complete(handle_rrule=True, rrule_mode="safe"), reload()).
  • §8: on CalDAV, native is None on the item a write returns (add(), save(), and so complete()/uncomplete()) when the server answers with an ETag; get(), search() and reload() set it; files and memory set it on writes too.
  • §9: the two complete() rows say "not yet" / "planned" instead of "same modes"; the "not yet" paragraph and §9.1 step 3 follow.
  • ROADMAP, Risks: recurrence editing depends on edit-icalendar, which has a README and no code yet and is not scheduled by any roadmap item.
  • news/29.documentation.rst.

No code change. Refs #29.

Prepared with AI assistance (Claude Code).

JaroAI777 and others added 2 commits October 25, 2026 11:23
…on CalDAV

API_DESIGN §9 said caldav's complete(handle_rrule=True, rrule_mode=…) maps
to task.complete(mode=…) with "same modes", but every backend declares
task.complete-recurring UNSUPPORTED until edit-icalendar has it (Q3,
decided 2026-10-23), and edit-icalendar has no code yet.

- §3.7: complete() on a task with an RRULE raises; link edit-icalendar
  issue 3; the CalDAV escape hatch meanwhile.
- §8: on CalDAV, native is None on the item add()/save() (and so
  complete()/uncomplete()) return when the server answers with an ETag.
- §9: the two complete() rows are "not yet" / planned; §9.1 step 3
  keeps recurring completion on caldav for now.
- ROADMAP Risks: recurrence editing depends on edit-icalendar.

Refs PyCalendar#29.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant