docs: make Rust docs consistent #2139
Annotations
2 errors and 11 warnings
Cargo clippy
reviewdog: Too many results (annotations) in diff.
You may miss some annotations due to GitHub limitation for annotation created by logging command.
Please check GitHub Actions log console to see all results.
Limitation:
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren't created by users)
Source: https://github.com/orgs/community/discussions/26680#discussioncomment-3252835
|
Cargo clippy
reviewdog exited with status code: 1
|
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636
|
Cargo clippy:
contracts/src/access/ownable_two_step.rs#L146
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/access/ownable_two_step.rs:146:9
|
146 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
= note: `-W clippy::doc-lazy-continuation` implied by `-W clippy::all`
= help: to override `-W clippy::all` add `#[allow(clippy::doc_lazy_continuation)]`
help: indent this line
|
146 | /// is returned.
| +
Raw Output:
contracts/src/access/ownable_two_step.rs:146:9:w:warning: doc list item without indentation
--> contracts/src/access/ownable_two_step.rs:146:9
|
146 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
= note: `-W clippy::doc-lazy-continuation` implied by `-W clippy::all`
= help: to override `-W clippy::all` add `#[allow(clippy::doc_lazy_continuation)]`
help: indent this line
|
146 | /// is returned.
| +
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L540
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:540:8
|
540 | /// equal to length of `values`.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
540 | /// equal to length of `values`.
| ++
Raw Output:
contracts/src/token/erc1155/mod.rs:540:8:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:540:8
|
540 | /// equal to length of `values`.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
540 | /// equal to length of `values`.
| ++
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L541
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:541:8
|
541 | ///[`Error::InsufficientBalance`] - Returned when `value` is greater than
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
541 | /// [`Error::InsufficientBalance`] - Returned when `value` is greater than
| +++
Raw Output:
contracts/src/token/erc1155/mod.rs:541:8:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:541:8
|
541 | ///[`Error::InsufficientBalance`] - Returned when `value` is greater than
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
541 | /// [`Error::InsufficientBalance`] - Returned when `value` is greater than
| +++
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L542
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:542:8
|
542 | /// the balance of the `from` account
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
542 | /// the balance of the `from` account
| ++
Raw Output:
contracts/src/token/erc1155/mod.rs:542:8:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:542:8
|
542 | /// the balance of the `from` account
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
542 | /// the balance of the `from` account
| ++
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L546
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:546:8
|
546 | /// id or returned with error.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
546 | /// id or returned with error.
| ++
Raw Output:
contracts/src/token/erc1155/mod.rs:546:8:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:546:8
|
546 | /// id or returned with error.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
546 | /// id or returned with error.
| ++
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L548
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:548:8
|
548 | /// `IERC1155Receiver::on_erc_1155_batch_received` hasn't returned its
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
548 | /// `IERC1155Receiver::on_erc_1155_batch_received` hasn't returned its
| ++
Raw Output:
contracts/src/token/erc1155/mod.rs:548:8:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:548:8
|
548 | /// `IERC1155Receiver::on_erc_1155_batch_received` hasn't returned its
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
548 | /// `IERC1155Receiver::on_erc_1155_batch_received` hasn't returned its
| ++
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L549
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:549:8
|
549 | /// interface id or returned with error.
| ^^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
549 | /// interface id or returned with error.
| +
Raw Output:
contracts/src/token/erc1155/mod.rs:549:8:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:549:8
|
549 | /// interface id or returned with error.
| ^^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
549 | /// interface id or returned with error.
| +
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L795
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:795:9
|
795 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
795 | /// is returned.
| +
Raw Output:
contracts/src/token/erc1155/mod.rs:795:9:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:795:9
|
795 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
795 | /// is returned.
| +
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L799
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:799:9
|
799 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
799 | /// is returned.
| +
Raw Output:
contracts/src/token/erc1155/mod.rs:799:9:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:799:9
|
799 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
799 | /// is returned.
| +
__END__
|
Cargo clippy:
contracts/src/token/erc1155/mod.rs#L865
[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:865:9
|
865 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
865 | /// is returned.
| ++
Raw Output:
contracts/src/token/erc1155/mod.rs:865:9:w:warning: doc list item without indentation
--> contracts/src/token/erc1155/mod.rs:865:9
|
865 | /// is returned.
| ^
|
= help: if this is supposed to be its own paragraph, add a blank line
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
|
865 | /// is returned.
| ++
__END__
|
Loading