Skip to content

docs: fix incorrect CLI help and a garbled doc comment - #7463

Open
0xDevNinja wants to merge 4 commits into
ChainSafe:mainfrom
0xDevNinja:0xdevninja/fix-cli-help-and-doc-text
Open

docs: fix incorrect CLI help and a garbled doc comment#7463
0xDevNinja wants to merge 4 commits into
ChainSafe:mainfrom
0xDevNinja:0xdevninja/fix-cli-help-and-doc-text

Conversation

@0xDevNinja

@0xDevNinja 0xDevNinja commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

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-limit help said In milliGas, but the value is passed straight into Message.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 that 0 lets the node estimate it.
  • healthcheck live and healthcheck healthy both described their --wait flag as Don't exit until node is ready, copied from the ready subcommand, even though they poll the livez and healthz endpoints. Each help string now points at the probe the command actually waits on.
  • The doc comment on EthEventHandler::collect_events_from_messages had 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

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Outside contributions

  • This pull request is based on an issue that a maintainer has accepted (see Before Opening a Pull Request).
  • I have read and agree to the CONTRIBUTING document.
  • I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

  • Documentation
    • Clarified that health-check wait options wait for a node to become live or healthy.
    • Corrected event collection guidance for messages that still need loading.
    • Updated wallet send help text to explain gas units and automatic estimation when set to 0.

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.
@0xDevNinja
0xDevNinja requested a review from a team as a code owner August 7, 2026 10:23
@0xDevNinja
0xDevNinja requested review from EclesioMeloJunior and hanabi1224 and removed request for a team August 7, 2026 10:23
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: beed6b3d-a81e-48f3-b5fd-11692febf8bc

📥 Commits

Reviewing files that changed from the base of the PR and between 9c30523 and ee0be65.

📒 Files selected for processing (3)
  • src/cli/subcommands/healthcheck_cmd.rs
  • src/rpc/methods/eth/filter/mod.rs
  • src/wallet/subcommands/wallet_cmd.rs
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • filecoin-project/lotus (manual)

Walkthrough

The changes correct descriptions for health-check wait options, wallet gas limits, and the collect_events RPC documentation. No public declarations or runtime behavior changed.

Changes

Documentation corrections

Layer / File(s) Summary
Command help text
src/cli/subcommands/healthcheck_cmd.rs, src/wallet/subcommands/wallet_cmd.rs
Health-check descriptions now use “live” and “healthy.” Wallet gas-limit help now describes gas units and node estimation when the value is 0.
RPC documentation
src/rpc/methods/eth/filter/mod.rs
The collect_events documentation now states that it applies when executed messages still need to be loaded.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: hanabi1224, lesnyrumcajs, eclesiomelojunior

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation fixes, including incorrect CLI help and the garbled documentation comment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@EclesioMeloJunior
EclesioMeloJunior self-requested a review August 7, 2026 12:35
@codecov

codecov Bot commented Aug 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.08%. Comparing base (9199a82) to head (b5f521d).
✅ All tests successful. No failed tests found.

Additional details and impacted files
Files with missing lines Coverage Δ
src/cli/subcommands/healthcheck_cmd.rs 0.00% <ø> (ø)
src/rpc/methods/eth/filter/mod.rs 89.46% <ø> (ø)
src/wallet/subcommands/wallet_cmd.rs 27.40% <ø> (ø)

... and 10 files with indirect coverage changes


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9199a82...b5f521d. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants