docs: fix incorrect CLI help and a garbled doc comment - #7463
Conversation
The --gas-limit help said "In milliGas", but the value is passed straight into Message.gas_limit, which is a count of gas units, with no milligas conversion on the path. A user trusting the help would set a limit 1000x too small. Describe it as gas units and note that 0 lets the node estimate it.
The --wait help for the `live` and `healthy` subcommands both read "Don't exit until node is ready", copied from `ready`, even though they poll the livez and healthz endpoints respectively. Point each help string at the probe the command actually waits on.
The last line of the doc comment was mangled into non-text
("wages sthen the executed messill need to be loaded"). Restore the
intended sentence.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
WalkthroughThe changes correct descriptions for health-check wait options, wallet gas limits, and the ChangesDocumentation corrections
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
... and 10 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Summary of changes
Three small, self-contained documentation fixes found while reading through the CLI and RPC code. No behaviour changes.
Changes introduced in this pull request:
wallet send --gas-limithelp saidIn milliGas, but the value is passed straight intoMessage.gas_limit(a count of gas units) with no milligas conversion anywhere on the path, so a user trusting the help would set a limit 1000x too small. Reworded to say gas units and note that0lets the node estimate it.healthcheck liveandhealthcheck healthyboth described their--waitflag asDon't exit until node is ready, copied from thereadysubcommand, even though they poll thelivezandhealthzendpoints. Each help string now points at the probe the command actually waits on.EthEventHandler::collect_events_from_messageshad a garbled last line (wages sthen the executed messill need to be loaded). Restored the intended sentence.Reference issue to close (if applicable)
Closes
Other information and links
Pure documentation and CLI help text. No functional change, so no CHANGELOG entry.
Change checklist
Outside contributions
Summary by CodeRabbit
0.