Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

docs: refresh stale docstrings from recent refactors (#2354)

Worktrunk Botb8704803bc07
diff --git a/src/commands/list/collect/mod.rs b/src/commands/list/collect/mod.rs
index 1902f348d..771d5c568 100644
--- a/src/commands/list/collect/mod.rs
+++ b/src/commands/list/collect/mod.rs
@@ -68,8 +68,10 @@
//! command returns quickly after signaling the daemon. By the time the worker thread
//! starts executing `git status` commands, daemons have had time to initialize.
//!
-//! **Invalid default branch warning:** `invalid_default_branch_config()` reads the value
-//! cached by `default_branch()` during pre-skeleton. It's a pure cache read.
+//! **Stale default branch warning:** The post-skeleton `warn_stale_default`
+//! check compares `default_branch()` (resolved pre-skeleton) against the
+//! local branch list — reusing the list fetched for `--branches`, otherwise
+//! adding one `for-each-ref` fork when the persisted default isn't a worktree branch.
//!
//! When adding new features, ask: "Can this be computed after skeleton?" If yes, defer it.
//! The skeleton shows `·` placeholder for gutter symbols, filled in when data loads.
diff --git a/src/git/repository/config.rs b/src/git/repository/config.rs
index c87e44fc3..d9c06daa1 100644
--- a/src/git/repository/config.rs
+++ b/src/git/repository/config.rs
@@ -222,8 +222,8 @@ impl Repository {
/// List all hints that have been shown in this repo.
///
- /// Output is sorted alphabetically for deterministic rendering — the
- /// `HashMap` backing `all_config` doesn't preserve insertion order.
+ /// Output is sorted alphabetically so hints render in a predictable
+ /// user-facing order regardless of git's config file layout.
pub fn list_shown_hints(&self) -> Vec<String> {
let Ok(lock) = self.all_config() else {
return Vec::new();