Skip to content

docs: api readme

docs: api readme #1692

GitHub Actions / clippy succeeded Nov 1, 2024 in 3s

clippy

180 warnings

Details

Results

Message level Amount
Internal compiler error 0
Error 0
Warning 180
Note 0
Help 0

Versions

  • rustc 1.82.0 (f6e511eec 2024-10-15)
  • cargo 1.82.0 (8f40fc59f 2024-08-21)
  • clippy 0.1.82 (f6e511e 2024-10-15)

Annotations

Check warning on line 44 in node/src/cli.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

large size difference between variants

warning: large size difference between variants
  --> node/src/cli.rs:5:1
   |
5  | / pub enum Subcommand {
6  | |     /// Build a chain specification.
7  | |     BuildSpec(sc_cli::BuildSpecCmd),
...  |
19 | |     ImportBlocks(sc_cli::ImportBlocksCmd),
   | |     ------------------------------------- the second-largest variant contains at least 240 bytes
...  |
39 | |     Benchmark(frame_benchmarking_cli::BenchmarkCmd),
   | |     ----------------------------------------------- the largest variant contains at least 544 bytes
...  |
43 | |     Key(sc_cli::KeySubcommand),
44 | | }
   | |_^ the entire enum is at least 544 bytes
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#large_enum_variant
   = note: `#[warn(clippy::large_enum_variant)]` on by default
help: consider boxing the large fields to reduce the total size of the enum
   |
39 |     Benchmark(Box<frame_benchmarking_cli::BenchmarkCmd>),
   |               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Check warning on line 34 in node/src/rpc.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

field `backend` is never read

warning: field `backend` is never read
  --> node/src/rpc.rs:34:6
   |
26 | pub struct FullDeps<C, P, B> {
   |            -------- field in this struct
...
34 |     pub backend: Arc<B>,
   |         ^^^^^^^
   |
   = note: `#[warn(dead_code)]` on by default

Check warning on line 1006 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a function

warning: missing documentation for a function
    --> runtime/testnet/src/lib.rs:659:1
     |
659  | / impl_runtime_apis! {
660  | |
661  | |     impl sp_consensus_aura::AuraApi<Block, AuraId> for Runtime {
662  | |         fn slot_duration() -> sp_consensus_aura::SlotDuration {
...    |
1005 | |     }
1006 | | }
     | |_^
     |
     = note: this warning originates in the macro `impl_runtime_apis` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 1006 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a module

warning: missing documentation for a module
    --> runtime/testnet/src/lib.rs:659:1
     |
659  | / impl_runtime_apis! {
660  | |
661  | |     impl sp_consensus_aura::AuraApi<Block, AuraId> for Runtime {
662  | |         fn slot_duration() -> sp_consensus_aura::SlotDuration {
...    |
1005 | |     }
1006 | | }
     | |_^
     |
     = note: this warning originates in the macro `impl_runtime_apis` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 1006 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a constant

warning: missing documentation for a constant
    --> runtime/testnet/src/lib.rs:659:1
     |
659  | / impl_runtime_apis! {
660  | |
661  | |     impl sp_consensus_aura::AuraApi<Block, AuraId> for Runtime {
662  | |         fn slot_duration() -> sp_consensus_aura::SlotDuration {
...    |
1005 | |     }
1006 | | }
     | |_^
     |
     = note: this warning originates in the macro `impl_runtime_apis` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 1006 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
    --> runtime/testnet/src/lib.rs:659:1
     |
659  | / impl_runtime_apis! {
660  | |
661  | |     impl sp_consensus_aura::AuraApi<Block, AuraId> for Runtime {
662  | |         fn slot_duration() -> sp_consensus_aura::SlotDuration {
...    |
1005 | |     }
1006 | | }
     | |_^
     |
     = note: this warning originates in the macro `impl_runtime_apis` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 554 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for an associated function

warning: missing documentation for an associated function
   --> runtime/testnet/src/lib.rs:554:1
    |
554 | #[frame_support::runtime]
    | ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this warning originates in the attribute macro `frame_support::runtime` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 554 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a type alias

warning: missing documentation for a type alias
   --> runtime/testnet/src/lib.rs:554:1
    |
554 | #[frame_support::runtime]
    | ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this warning originates in the attribute macro `frame_support::runtime` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 554 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct field

warning: missing documentation for a struct field
   --> runtime/testnet/src/lib.rs:554:1
    |
554 | #[frame_support::runtime]
    | ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this warning originates in the attribute macro `frame_support::runtime` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 554 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a variant

warning: missing documentation for a variant
   --> runtime/testnet/src/lib.rs:554:1
    |
554 | #[frame_support::runtime]
    | ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this warning originates in the attribute macro `frame_support::runtime` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 554 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for an enum

warning: missing documentation for an enum
   --> runtime/testnet/src/lib.rs:554:1
    |
554 | #[frame_support::runtime]
    | ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this warning originates in the attribute macro `frame_support::runtime` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 554 in runtime/testnet/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:554:1
    |
554 | #[frame_support::runtime]
    | ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this warning originates in the attribute macro `frame_support::runtime` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:529:1
    |
529 | / parameter_types! {
530 | |     // One storage item; key size is 32; value is size 4+4+16+32 bytes = 56 bytes.
531 | |     pub const DepositBase: Balance = deposit(1, 88);
532 | |     // Additional storage item size of 32 bytes.
533 | |     pub const DepositFactor: Balance = deposit(0, 32);
534 | |     pub const MaxSignatories: u32 = 100;
535 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:529:1
    |
529 | / parameter_types! {
530 | |     // One storage item; key size is 32; value is size 4+4+16+32 bytes = 56 bytes.
531 | |     pub const DepositBase: Balance = deposit(1, 88);
532 | |     // Additional storage item size of 32 bytes.
533 | |     pub const DepositFactor: Balance = deposit(0, 32);
534 | |     pub const MaxSignatories: u32 = 100;
535 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:529:1
    |
529 | / parameter_types! {
530 | |     // One storage item; key size is 32; value is size 4+4+16+32 bytes = 56 bytes.
531 | |     pub const DepositBase: Balance = deposit(1, 88);
532 | |     // Additional storage item size of 32 bytes.
533 | |     pub const DepositFactor: Balance = deposit(0, 32);
534 | |     pub const MaxSignatories: u32 = 100;
535 | | }
    | |_^
    |
    = note: this warning originates in the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:510:1
    |
510 | / parameter_types! {
511 | |     pub const PreimageHoldReason: RuntimeHoldReason = RuntimeHoldReason::Preimage(pallet_preimage::HoldReason::Preimage);
512 | |     pub const PreimageBaseDeposit: Balance = deposit(2, 64);
513 | |     pub const PreimageByteDeposit: Balance = deposit(0, 1);
514 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:510:1
    |
510 | / parameter_types! {
511 | |     pub const PreimageHoldReason: RuntimeHoldReason = RuntimeHoldReason::Preimage(pallet_preimage::HoldReason::Preimage);
512 | |     pub const PreimageBaseDeposit: Balance = deposit(2, 64);
513 | |     pub const PreimageByteDeposit: Balance = deposit(0, 1);
514 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:510:1
    |
510 | / parameter_types! {
511 | |     pub const PreimageHoldReason: RuntimeHoldReason = RuntimeHoldReason::Preimage(pallet_preimage::HoldReason::Preimage);
512 | |     pub const PreimageBaseDeposit: Balance = deposit(2, 64);
513 | |     pub const PreimageByteDeposit: Balance = deposit(0, 1);
514 | | }
    | |_^
    |
    = note: this warning originates in the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 277 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:489:1
    |
489 | / parameter_types! {
490 | |     pub MaximumSchedulerWeight: Weight = Perbill::from_percent(60) *
491 | |         RuntimeBlockWeights::get().max_block;
492 | | }
    | |_^
    |
    = note: this warning originates in the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:460:1
    |
460 | / parameter_types! {
461 | |     pub const PotId: PalletId = PalletId(*b"PotStake");
462 | |     pub const SessionLength: BlockNumber = 6 * HOURS;
463 | |     // StakingAdmin pluralistic body.
464 | |     pub const StakingAdminBodyId: BodyId = BodyId::Defense;
465 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:460:1
    |
460 | / parameter_types! {
461 | |     pub const PotId: PalletId = PalletId(*b"PotStake");
462 | |     pub const SessionLength: BlockNumber = 6 * HOURS;
463 | |     // StakingAdmin pluralistic body.
464 | |     pub const StakingAdminBodyId: BodyId = BodyId::Defense;
465 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:460:1
    |
460 | / parameter_types! {
461 | |     pub const PotId: PalletId = PalletId(*b"PotStake");
462 | |     pub const SessionLength: BlockNumber = 6 * HOURS;
463 | |     // StakingAdmin pluralistic body.
464 | |     pub const StakingAdminBodyId: BodyId = BodyId::Defense;
465 | | }
    | |_^
    |
    = note: this warning originates in the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:433:1
    |
433 | / parameter_types! {
434 | |     pub const Period: u32 = 6 * HOURS;
435 | |     pub const Offset: u32 = 0;
436 | | }
    | |_^
    |
    = note: this warning originates in the macro `$crate::parameter_types` which comes from the expansion of the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 265 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:433:1
    |
433 | / parameter_types! {
434 | |     pub const Period: u32 = 6 * HOURS;
435 | |     pub const Offset: u32 = 0;
436 | | }
    | |_^
    |
    = note: this warning originates in the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)

Check warning on line 277 in /home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-support-36.0.0/src/lib.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

missing documentation for a struct

warning: missing documentation for a struct
   --> runtime/testnet/src/lib.rs:382:1
    |
382 | / parameter_types! {
383 | |     pub MessageQueueServiceWeight: Weight = Perbill::from_percent(35) * RuntimeBlockWeights::get().max_block;
384 | | }
    | |_^
    |
    = note: this warning originates in the macro `parameter_types` (in Nightly builds, run with -Z macro-backtrace for more info)