Background
Many RPC method implementations in Forest are missing the DESCRIPTION constant, which should provide documentation about what each method does.
Task
Add the DESCRIPTION field to all RPC method implementations throughout the codebase. This will improve API documentation and help users understand what each method does.
Example
impl RpcMethod<2> for EthTraceReplayBlockTransactions {
const NAME: &'static str = "Filecoin.EthTraceReplayBlockTransactions";
const NAME_ALIAS: Option<&'static str> = Some("trace_replayBlockTransactions");
const DESCRIPTION: Option<&'static str> = Some(
"Replays all transactions in a block returning the requested traces for each transaction.",
);
// ...
}
Context
Related PR: #6444
Related comment: #6444 (comment)
cc: @akaladarshi
Background
Many RPC method implementations in Forest are missing the
DESCRIPTIONconstant, which should provide documentation about what each method does.Task
Add the
DESCRIPTIONfield to all RPC method implementations throughout the codebase. This will improve API documentation and help users understand what each method does.Example
Context
Related PR: #6444
Related comment: #6444 (comment)
cc: @akaladarshi