Skip to content

Fix stale sync docs still showing the old 4-tuple return - #74

Merged
SashankBhamidi merged 1 commit into
mainfrom
docs/fix-stale-sync-examples
Oct 24, 2026
Merged

SashankBhamidi merged 1 commit into
mainfrom
docs/fix-stale-sync-examples

Conversation

@SashankBhamidi

@SashankBhamidi SashankBhamidi commented Oct 24, 2026 •

Copy link
Copy Markdown
Member

docs/how-to/sync.rst and docs/how-to/example-sync-cache.rst still unpacked get_objects_by_sync_token into a 4-tuple and described the removed serverPartialFail exception, left over from before #69/#71 changed the return shape to a 6-tuple with paging.

Fixed both to unpack (added, modified, deleted, old_state, new_state, has_more_changes) and loop on has_more_changes instead of catching an error that no longer gets raised.

The sync-cache example also keyed its sync token by calendar id, which was always wrong. JMAP state covers the whole account, not one calendar; fixed to key it by account, with a single-row table instead of one row per calendar.

@SashankBhamidi
SashankBhamidi removed the request for review from stevepiercy October 24, 2026 07:31
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 calendaring-jmap | 🛠️ Build #35373782 | 📁 Comparing e857eb0 against latest (5f718cc)

  🔍 Preview build  

4 files changed
± how-to/errors.html
± how-to/example-sync-cache.html
± how-to/sync.html
± reference/index.html

@codecov

codecov Bot commented Oct 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@SashankBhamidi
SashankBhamidi merged commit ebdace4 into main Oct 24, 2026
14 checks passed
@SashankBhamidi
SashankBhamidi deleted the docs/fix-stale-sync-examples branch October 24, 2026 07:47
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