Skip to content

Commit bbb01d1

Browse files
committed
cli(sync[docs]): Document plan config fields
why: SyncPlanConfig fields render bare in the API reference, hiding that offline overrides fetch. what: - Add an Attributes section to SyncPlanConfig - Record that fetch refreshes remote refs before status is read, and that offline suppresses it and plans repos with uncomparable remote state as updates
1 parent a7e940d commit bbb01d1

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

src/vcspull/cli/sync.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,18 @@
8686

8787
@dataclass
8888
class SyncPlanConfig:
89-
"""Configuration options for building sync plans."""
89+
"""Configuration options for building sync plans.
90+
91+
Attributes
92+
----------
93+
fetch : bool
94+
Run ``git fetch --prune`` before reading status (``--fetch``), so
95+
ahead/behind counts reflect current remote refs. Ignored when
96+
``offline`` is set.
97+
offline : bool
98+
Plan without touching the network (``--offline``). Repositories whose
99+
remote state cannot be compared are planned as updates.
100+
"""
90101

91102
fetch: bool
92103
offline: bool

0 commit comments

Comments
 (0)