Skip to content

test(docs): drop the command-page sync test its docs file outlived - #3802

Merged
max-sixty merged 1 commit into
mainfrom
nightly/clean-31571122831
Aug 12, 2026
Merged

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

Conversation

@worktrunk-bot

Copy link
Copy Markdown
Collaborator

test_docs_commands_are_in_sync has passed without running since 2025-12-02. It targets docs/content/commands.md, which 3f81f28 ("Docs: Split command pages with --help-page generation") deleted when the single command page became one page per command — so its first statement is an exists() guard that has been false on every run for eight months, and the test returns before it does anything.

let commands_path = project_root.join("docs/content/commands.md");

if !commands_path.exists() {
    // Skip if docs directory doesn't exist
    return;
}

That makes it the shape running-tend warns about under Don't fix tests by adding skip guards — a green result that asserts nothing. sync_help_markers is dead with it: the skipped test is its only caller, so both go.

Nothing else in the file is reachable only from these two. help_output, format_replacement, OutputFormat::Unwrapped, MARKER_PATTERN, trim_lines, and MarkerType::Help all stay live through sync_readme_markers, which is the near-identical function that survived the split and still syncs README markers.

No sync coverage is lost. The job this test was written for — keeping rendered --help in a docs page current with after_long_help — moved to test_docs_are_in_sync, whose Step 1 (sync_command_pages, mod.rs → docs/content/*.md) covers the per-command pages that replaced commands.md.

Testing

No regression test: the change deletes test code that cannot execute, so there is nothing to assert about it that the deletion doesn't already settle. Verified instead that the file still compiles warning-free (cargo test --test integration --no-run, cargo clippy --test integration) and that the remaining 14 readme_sync tests pass, test_docs_are_in_sync among them.

@worktrunk-bot worktrunk-bot added the nightly-cleanup Issues found by nightly code quality sweep label Aug 12, 2026
@max-sixty
max-sixty merged commit b688e81 into main Aug 12, 2026
37 of 47 checks passed
@max-sixty
max-sixty deleted the nightly/clean-31571122831 branch August 12, 2026 12:37
@max-sixty max-sixty mentioned this pull request Aug 12, 2026
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