Skip to content

docs: correct three stale code references found in the nightly survey - #3989

Merged
max-sixty merged 1 commit into
mainfrom
nightly/clean-33600107633
Sep 2, 2026
Merged

max-sixty merged 1 commit into
mainfrom
nightly/clean-33600107633

Conversation

@worktrunk-bot

Copy link
Copy Markdown
Collaborator

Three code references that no longer match the code they describe, found in tonight's rolling survey (src/commands/list/ci_status/gitlab.rs) and in a follow-up pass over the past 24 hours of commits. Comment-only; no behavior change, so no test — cargo check --lib --bins and cargo fmt --check pass locally.

1. An orphaned docstring in gitlab.rs

The block describing glab mr list output — "Basic MR info… glab mr list does NOT return head_pipeline… We include source_project_id for client-side filtering" — sits on GitLabMrAuthor, a two-field struct holding only username. #3252 inserted GitLabMrAuthor directly beneath that docstring, which had been written for GitLabMrListEntry immediately below. Nothing catches it: it is a valid docstring on a valid item, and #3490 later edited its # Filtering Strategy cross-reference without noticing it had been reattached. Moved back onto GitLabMrListEntry; GitLabMrAuthor gets a one-liner.

2. src/commands/list/model.rs no longer exists

colorize_status_symbols in src/md_help.rs says its palette matches src/commands/list/model.rs StatusSymbols::styled_symbols. model is a directory now, and both the struct and the method live in model/status_symbols.rs. Repointed.

3. --execute has no "no-integration fallback"

CLAUDE.md's Git-Discovery Env Vars rule lists the spawn sites that must scrub GIT_DIR/GIT_WORK_TREE, naming "the --execute no-integration fallback". That was accurate when a shell-integrated --execute went through the wrapper's EXEC directive and only the non-integrated path spawned from wt. #3977 retired the directive: --execute is now a single spawn from wt in every case. The rationale docstring on scrub_git_discovery_env_vars was updated there ("the --execute program (run in the switch target)"); CLAUDE.md, which points readers at it, was not. Aligned to match.

Verification

Finding 1, confirmed by history rather than by reading:

$ git log --oneline -L 296,315:src/commands/list/ci_status/gitlab.rs

shows GitLabMrAuthor added under the pre-existing docstring in a725a2d (#3252), and 1ebd7b0 (#3490) editing that docstring in place afterwards.

Findings 2 and 3 were found by extracting every path/to/file.ext and `symbol()` reference out of doc comments across src/, tests/, and the CLAUDE.md files and checking each against the tree. Everything else resolved — the remaining misses are external-crate paths (skim's src/tui/preview.rs, renamore::rename_exclusive), illustrative placeholders in recipes, and plugins/worktrunk/plugin.json, which config_show.rs asserts is absent.

- Reattach the GitLabMrListEntry docstring, orphaned onto GitLabMrAuthor when that struct was inserted above it in #3252.
- Point md_help.rs's StatusSymbols cross-reference at model/status_symbols.rs; model.rs became a directory.
- Drop CLAUDE.md's "--execute no-integration fallback"; #3977 made --execute one spawn site with no fallback.
@worktrunk-bot worktrunk-bot added the nightly-cleanup Issues found by nightly code quality sweep label Sep 2, 2026
@max-sixty
max-sixty merged commit 7ac6357 into main Sep 2, 2026
37 of 47 checks passed
@max-sixty
max-sixty deleted the nightly/clean-33600107633 branch September 2, 2026 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

nightly-cleanup Issues found by nightly code quality sweep

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants