docs(rpc): add DESCRIPTION to chain RPC methods#7207
Conversation
WalkthroughAdds ChangesChain RPC Method Descriptions
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
akaladarshi
left a comment
There was a problem hiding this comment.
Couple of comments otherwise LGTM
| const API_PATHS: BitFlags<ApiPaths> = ApiPaths::all_with_v2(); | ||
| const PERMISSION: Permission = Permission::Read; | ||
| const DESCRIPTION: Option<&'static str> = Some( | ||
| "Exports a chain snapshot to a CAR file from the given epoch; only one export may run at a time.", |
There was a problem hiding this comment.
Should we add some kind of differentiation between the ForestChainExport and ChainExport?.
| const API_PATHS: BitFlags<ApiPaths> = ApiPaths::all(); | ||
| const PERMISSION: Permission = Permission::Read; | ||
| const DESCRIPTION: Option<&'static str> = Some( | ||
| "Returns the minimum parent base fee across the given number of lookback tipsets, in attoFIL.", |
There was a problem hiding this comment.
I think we should remove the parent base fee because the name suggests ChainGetMinBaseFee but the calculations uses the parent_base_fee.
Not sure for the correct thing here, so just pointing out.
Summary of changes
Changes introduced in this pull request:
Reference issue to close (if applicable)
Part of #6460
Other information and links
Change checklist
Outside contributions
Summary by CodeRabbit
Release Notes