Repository navigation
test(docs): drop the command-page sync test its docs file outlived - #3802
Merged
Merged
Conversation
Merged
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.
test_docs_commands_are_in_synchas passed without running since 2025-12-02. It targetsdocs/content/commands.md, which 3f81f28 ("Docs: Split command pages with--help-pagegeneration") deleted when the single command page became one page per command — so its first statement is anexists()guard that has been false on every run for eight months, and the test returns before it does anything.That makes it the shape
running-tendwarns about under Don't fix tests by adding skip guards — a green result that asserts nothing.sync_help_markersis 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, andMarkerType::Helpall stay live throughsync_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
--helpin a docs page current withafter_long_help— moved totest_docs_are_in_sync, whose Step 1 (sync_command_pages,mod.rs→docs/content/*.md) covers the per-command pages that replacedcommands.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 14readme_synctests pass,test_docs_are_in_syncamong them.