pimutils / pimutils/vdirsyncer
Document one-way sync
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 185
- Avg merge
- 11h 49m
- Merged PRs (30d)
- 1
Description
Vdirsyncer supports one-way (unidirectional) sync as described in #468. However, this is not obvious in the documentation. It actually took me a while to find it and verify that it works by implementing a new unit test. Here is a suggestion: In Syncing with read-only storages, replace the paragraph
You may get [...] rights to do so.
by the following text:
You may get into a situation where you want to delete, modify or add some events in your
holidayscalendar. If you try to do that, you’ll notice that vdirsyncer will revert any changes you’ve made after a few times of runningsync, restoring deleted events, reverting changed events, and deleting added events. This is because vdirsyncer wants to keep everything in sync, and it can’t synchronize changes to the public holidays calendar because it doesn’t have the rights to do so.
Also in the manual, it would be good to document that partial_sync = "ignore" prevents items in B but not in A from being erased during synchronization.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the “Syncing with read-only storages” section at the linked partial-sync documentation anchor and the partial_sync definition in the linked configuration manual. Update the explanation to make one-way synchronization and partial_sync = "ignore" behavior explicit, then verify both pages clearly describe what happens to items present only in B.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100