fix(docs): align CLI help text with commands reference for check-docs parity#2332
Closed
gaveezy wants to merge 1 commit into
Closed
fix(docs): align CLI help text with commands reference for check-docs parity#2332gaveezy wants to merge 1 commit into
gaveezy wants to merge 1 commit into
Conversation
… parity Three issues caused the check-docs CLI parity check to fail: 1. Three help() lines in src/nemoclaw.ts used single-space separation between the command signature and its description, so the check-docs normalizer included description text in the normalized output. Fixed by widening to 2+ spaces (channels remove, policy-remove, credentials reset). 2. The docs-side normalizer in check-docs.sh did not strip trailing <arg> and [optional] placeholders the way the help-side normalizer does, producing false mismatches for commands like channels add <channel>. Added the same stripping to the docs extraction perl script. 3. Four commands present in --help had no ### heading in docs/reference/commands.md: onboard --from, setup, start, stop. Added headings for each (the latter three are deprecated aliases). Signed-off-by: Hai Nguyen <haingu@nvidia.com>
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
2 tasks
Contributor
|
✨ Thanks for submitting this issue that identifies a bug with the CLI help text and proposes a fix. Let us know when the draft is completed. Related open issues: |
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
3 participants
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.
Summary
The
check-docsCI step (cloud-experimental-e2e) fails because theCLI
--helpoutput anddocs/reference/commands.mdheadings are outof sync.
Root causes (all three fixed here):
Single-space description separators in
help()—channels remove,policy-remove, andcredentials resetuseda single space before their description text. The
check-docs.shnormalizer expects 2+ spaces as the delimiter, so description text
leaked into the normalized command signature, producing phantom
mismatches. Widened to 2 spaces.
Inconsistent trailing-arg stripping — the help-side normalizer
strips trailing
<arg>and[optional]placeholders, but thedocs-side normalizer did not. Commands like
nemoclaw <name> channels add <channel>(docs) normalizeddifferently from
nemoclaw <name> channels add(help). Added thesame stripping to the docs perl extraction script.
Missing
###headings — four commands present in--helphadno level-3 heading in
docs/reference/commands.md:onboard --from,setup,start,stop. Added headings foreach (the latter three are deprecated aliases).
Note: The same
cloud-experimental-e2ejob also reports a Landlock/sandboxwritability failure in its step 3 (04-landlock-readonly).That is an intermittent infrastructure-level issue unrelated to these
documentation changes and is tracked separately.
Test plan
cloud-experimental-e2eon this branch — thecheck-docs.shstep should passnemoclaw --helpoutput still renders correctlynightly-e2ejobs regressSigned-off-by: Hai Nguyen haingu@nvidia.com
🤖 Generated with Claude Code
Fixes #2333