docs(rpc): add DESCRIPTION to remaining small-module RPC methods#7209
docs(rpc): add DESCRIPTION to remaining small-module RPC methods#7209LesnyRumcajs wants to merge 1 commit into
Conversation
WalkthroughAdds ChangesRPC Method DESCRIPTION Constants
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerBuilt with CodeRabbit's Coding Plans for faster development and fewer bugs. View plan used: ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
... and 14 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
| const API_PATHS: BitFlags<ApiPaths> = ApiPaths::all(); | ||
| const PERMISSION: Permission = Permission::Admin; | ||
| const DESCRIPTION: Option<&'static str> = | ||
| Some("Marks the block with the given CID as bad in the bad-block cache."); |
There was a problem hiding this comment.
We can remove the cache from here, should we also add use with caution like lotus ?.
There was a problem hiding this comment.
We can remove the cache from here
why?
should we also add use with caution like lotus ?.
This method requires admin permissions, it's inherently supposed to be used with caution.
There was a problem hiding this comment.
why?
Just because it is user facing, so user shouldn't care if there is cache or something else, that's why.
Summary of changes
Changes introduced in this pull request:
Reference issue to close (if applicable)
Closes #6460
Other information and links
Change checklist
Outside contributions
Summary by CodeRabbit