Skip to content

Commit d09c553

Browse files
committed
types(docs[WorktreeConfigDict]) Fix lock_reason docstring accuracy
why: Documentation incorrectly stated lock_reason requires lock=True what: - Update docstring to reflect actual behavior: lock_reason implies lock=True
1 parent eb97d3b commit d09c553

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/vcspull/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class WorktreeConfigDict(TypedDict):
8282
"""Lock the worktree to prevent accidental removal."""
8383

8484
lock_reason: NotRequired[str | None]
85-
"""Reason for locking (requires lock=True)."""
85+
"""Reason for locking. If provided, implies lock=True."""
8686

8787

8888
class RawConfigDict(t.TypedDict):

0 commit comments

Comments
 (0)