Repository navigation
fix(e2e): normalize both sides of check-docs CLI parity check - #2265
Closed
kagura-chen wants to merge 1 commit into
Closed
kagura-chen wants to merge 1 commit into
kagura-chen wants to merge 1 commit into
Conversation
…#2250) The CLI parity check in check-docs.sh applies asymmetric normalization: the help side strips trailing <arg>/[arg] placeholders and descriptions separated by 2+ spaces, but the doc side extracts headings verbatim. This causes false mismatches when: 1. A commands.md heading includes argument placeholders (e.g. `nemoclaw <name> channels add <channel>`) — the doc side keeps them while the help side strips them. 2. A --help line has a description separated by a single space after the last argument (e.g. `channels remove <channel> Clear credentials and rebuild`) — the \s{2,} regex does not catch it, leaving description text in the normalized command. Fix both sides: - Help side: add a post-strip pass that removes residual description text starting with a capitalized word, then re-strip any <arg>/[arg] placeholders exposed by description removal. - Doc side: strip trailing <arg> and [arg] placeholders from headings, matching the help-side normalization. Signed-off-by: kagura-agent <[email protected]>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe CLI-doc parity check script is updated to normalize trailing argument placeholders and descriptive text symmetrically between CLI help output and documentation headings. Both sides now strip trailing Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
|
✨ Thanks for submitting this PR that proposes a way to improve the E2E testing process. Related open issues: |
Contributor
Author
wscurran
added
area: e2e
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.
Problem
The CLI parity check in
check-docs.shapplies asymmetric normalization tothe two sides it compares, causing false mismatches in the nightly E2E run.
Help side (phase 1) strips trailing
<arg>/[arg]placeholders anddescriptions separated by 2+ spaces, but:
channels remove <channel> Clear credentials and rebuild) slip throughthe
\s{2,}regex.<arg>/[arg]placeholders are not re-stripped.
Doc side (phase 2) extracts
### \nemoclaw …`headings **verbatim** without stripping argument placeholders, so headings likenemoclaw channels add ` never match the stripped help output.Fix
starting with a capitalized word (
/\s+[A-Z][a-z].*$/), then re-stripany
<arg>/[arg]placeholders exposed by the description removal.<arg>and[arg]placeholders fromheadings, applying the same normalization as the help side.
Testing
Verified both normalization paths produce identical output for all commands
listed in the issue's CI mismatch log.
Closes #2250
Summary by CodeRabbit