Skip to content

Commit a7e940d

Browse files
committed
cli(status[docs]): Document check config fields
why: StatusCheckConfig fields render bare in the API reference, with no hint of which CLI flag sets them or what they cost. what: - Add an Attributes section to StatusCheckConfig - Record that max_concurrent bounds the async semaphore and that detailed adds branch and ahead/behind at the price of extra git invocations per repository
1 parent 5e82a30 commit a7e940d

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

src/vcspull/cli/status.py

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

3131
@dataclass
3232
class StatusCheckConfig:
33-
"""Configuration options for status checking."""
33+
"""Configuration options for status checking.
34+
35+
Attributes
36+
----------
37+
max_concurrent : int
38+
Ceiling on repositories inspected at once (``--max-concurrent``),
39+
bounding the semaphore that guards the async checks.
40+
detailed : bool
41+
Collect the current branch and ahead/behind counts on top of the
42+
existence, VCS, and cleanliness checks (``--detailed``). Each extra
43+
field costs another git invocation per repository.
44+
"""
3445

3546
max_concurrent: int
3647
detailed: bool

0 commit comments

Comments
 (0)