pimutils / pimutils/vdirsyncer

Documentation is missing quotes for `partial_sync`

Open
#764 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
185
Avg merge
11h 49m
Merged PRs (30d)
1

Description

When the parameter of partial_sync is not quoted, e.g. partial_sync = ignore instead of partial_sync = "ignore", then the following error rises:

 option "partial_sync": Expecting value: line 1 column 1 (char 0)

However, the documentation indicating that the parameter should be used without quotes, so either the program or the documentation should be adopted.

Relevant sections are:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the pair-section and Step 3 sections linked in the issue, then compare their partial_sync examples with the reported parser error. Update the relevant documentation so the parameter choices and quoting are unambiguous, and verify both sections show consistent syntax.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.