Repository navigation
docs: correct three stale code references found in the nightly survey - #3989
Merged
Merged
Conversation
- 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 --binsandcargo fmt --checkpass locally.1. An orphaned docstring in
gitlab.rsThe block describing
glab mr listoutput — "Basic MR info…glab mr listdoes NOT returnhead_pipeline… We includesource_project_idfor client-side filtering" — sits onGitLabMrAuthor, a two-field struct holding onlyusername. #3252 insertedGitLabMrAuthordirectly beneath that docstring, which had been written forGitLabMrListEntryimmediately below. Nothing catches it: it is a valid docstring on a valid item, and #3490 later edited its# Filtering Strategycross-reference without noticing it had been reattached. Moved back ontoGitLabMrListEntry;GitLabMrAuthorgets a one-liner.2.
src/commands/list/model.rsno longer existscolorize_status_symbolsinsrc/md_help.rssays its palette matchessrc/commands/list/model.rs StatusSymbols::styled_symbols.modelis a directory now, and both the struct and the method live inmodel/status_symbols.rs. Repointed.3.
--executehas 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--executeno-integration fallback". That was accurate when a shell-integrated--executewent through the wrapper's EXEC directive and only the non-integrated path spawned fromwt. #3977 retired the directive:--executeis now a single spawn fromwtin every case. The rationale docstring onscrub_git_discovery_env_varswas updated there ("the--executeprogram (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:
shows
GitLabMrAuthoradded 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.extand`symbol()`reference out of doc comments acrosssrc/,tests/, and theCLAUDE.mdfiles and checking each against the tree. Everything else resolved — the remaining misses are external-crate paths (skim'ssrc/tui/preview.rs,renamore::rename_exclusive), illustrative placeholders in recipes, andplugins/worktrunk/plugin.json, whichconfig_show.rsasserts is absent.