docs: fix incorrect -f flag in logs examples, should be --follow#1023
docs: fix incorrect -f flag in logs examples, should be --follow#1023latenighthackathon wants to merge 1 commit intoNVIDIA:mainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughUpdated documentation examples in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/monitoring/monitor-sandbox-activity.md (1)
44-44: Consider splitting into one sentence per line.Line 44 contains two sentences. Per the style guide, one sentence per line makes diffs more readable.
📝 Suggested formatting
-Run `nemoclaw <name> status` on the host to check sandbox state. Use `openshell sandbox list` for the underlying sandbox details. +Run `nemoclaw <name> status` on the host to check sandbox state. +Use `openshell sandbox list` for the underlying sandbox details.As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/monitoring/monitor-sandbox-activity.md` at line 44, Split the two sentences on line 44 into separate lines so each sentence is one line: change "Run `nemoclaw <name> status` on the host to check sandbox state. Use `openshell sandbox list` for the underlying sandbox details." into two lines — one containing "Run `nemoclaw <name> status` on the host to check sandbox state." and the next containing "Use `openshell sandbox list` for the underlying sandbox details." — ensuring the exact sentence strings remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/monitoring/monitor-sandbox-activity.md`:
- Line 44: Split the two sentences on line 44 into separate lines so each
sentence is one line: change "Run `nemoclaw <name> status` on the host to check
sandbox state. Use `openshell sandbox list` for the underlying sandbox details."
into two lines — one containing "Run `nemoclaw <name> status` on the host to
check sandbox state." and the next containing "Use `openshell sandbox list` for
the underlying sandbox details." — ensuring the exact sentence strings remain
unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 835c297e-03bc-45a6-a3ca-3197619f5eab
📒 Files selected for processing (1)
docs/monitoring/monitor-sandbox-activity.md
The CLI only accepts --follow (bin/nemoclaw.js line 805), not -f. The commands reference (docs/reference/commands.md) correctly documents --follow but monitor-sandbox-activity.md used -f.
cccebbd to
959e6d2
Compare
Summary
Fix incorrect
-fshorthand indocs/monitoring/monitor-sandbox-activity.md. The CLI only accepts--follow— the-fflag is silently ignored, causing users to miss real-time log output.Related Issue
Fixes #1021
Changes
nemoclaw <name> logs -f→nemoclaw <name> logs --follownemoclaw <name> logs -f→nemoclaw <name> logs --followType of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Checklist
General
Doc Changes
Summary by CodeRabbit