Skip to content

chore: documentation and linting overhaul #743

chore: documentation and linting overhaul

chore: documentation and linting overhaul #743

Triggered via pull request February 28, 2025 16:23
Status Cancelled
Total duration 9m 51s
Artifacts

tests.yml

on: pull_request
Matrix: test
Fit to window
Zoom out
Zoom in

Annotations

5 errors and 10 warnings
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
clippy
reviewdog exited with status code: 1
doctest
Process completed with exit code 101.
test macos-latest
Canceling since a higher priority waiting request for 'test-jon-becker/docs' exists
test macos-latest
The operation was canceled.
clippy: crates/dump/src/lib.rs#L1
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for the crate --> crates/dump/src/lib.rs:1:1 | 1 | / pub mod error; 2 | | 3 | | mod core; 4 | | mod interfaces; ... | 8 | | pub use error::Error; 9 | | pub use interfaces::{DumpArgs, DumpArgsBuilder}; | |________________________________________________^ | = note: requested on the command line with `-W missing-docs` </code></pre> Raw Output: crates/dump/src/lib.rs:1:1:w: <pre><code>warning: missing documentation for the crate --> crates/dump/src/lib.rs:1:1 | 1 | / pub mod error; 2 | | 3 | | mod core; 4 | | mod interfaces; ... | 8 | | pub use error::Error; 9 | | pub use interfaces::{DumpArgs, DumpArgsBuilder}; | |________________________________________________^ | = note: requested on the command line with `-W missing-docs` </code></pre> __END__
clippy: crates/dump/src/lib.rs#L1
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for a module --> crates/dump/src/lib.rs:1:1 | 1 | pub mod error; | ^^^^^^^^^^^^^ </code></pre> Raw Output: crates/dump/src/lib.rs:1:1:w: <pre><code>warning: missing documentation for a module --> crates/dump/src/lib.rs:1:1 | 1 | pub mod error; | ^^^^^^^^^^^^^ </code></pre> __END__
clippy: crates/dump/src/error.rs#L4
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for an enum --> crates/dump/src/error.rs:4:1 | 4 | pub enum Error { | ^^^^^^^^^^^^^^ </code></pre> Raw Output: crates/dump/src/error.rs:4:1:w: <pre><code>warning: missing documentation for an enum --> crates/dump/src/error.rs:4:1 | 4 | pub enum Error { | ^^^^^^^^^^^^^^ </code></pre> __END__
clippy: crates/dump/src/error.rs#L6
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for a variant --> crates/dump/src/error.rs:6:5 | 6 | Eyre(#[from] eyre::Report), | ^^^^ </code></pre> Raw Output: crates/dump/src/error.rs:6:5:w: <pre><code>warning: missing documentation for a variant --> crates/dump/src/error.rs:6:5 | 6 | Eyre(#[from] eyre::Report), | ^^^^ </code></pre> __END__
clippy: crates/dump/src/core/mod.rs#L19
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for a function --> crates/dump/src/core/mod.rs:19:1 | 19 | pub async fn dump(args: DumpArgs) -> Result<HashMap<FixedBytes<32>, FixedBytes<32>>, Error> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ </code></pre> Raw Output: crates/dump/src/core/mod.rs:19:1:w: <pre><code>warning: missing documentation for a function --> crates/dump/src/core/mod.rs:19:1 | 19 | pub async fn dump(args: DumpArgs) -> Result<HashMap<FixedBytes<32>, FixedBytes<32>>, Error> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ </code></pre> __END__
clippy: crates/dump/src/interfaces/args.rs#L11
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for a struct --> crates/dump/src/interfaces/args.rs:11:1 | 11 | pub struct DumpArgs { | ^^^^^^^^^^^^^^^^^^^ </code></pre> Raw Output: crates/dump/src/interfaces/args.rs:11:1:w: <pre><code>warning: missing documentation for a struct --> crates/dump/src/interfaces/args.rs:11:1 | 11 | pub struct DumpArgs { | ^^^^^^^^^^^^^^^^^^^ </code></pre> __END__
clippy: crates/dump/src/interfaces/args.rs#L43
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for an associated function --> crates/dump/src/interfaces/args.rs:43:5 | 43 | pub fn new() -> Self { | ^^^^^^^^^^^^^^^^^^^^ </code></pre> Raw Output: crates/dump/src/interfaces/args.rs:43:5:w: <pre><code>warning: missing documentation for an associated function --> crates/dump/src/interfaces/args.rs:43:5 | 43 | pub fn new() -> Self { | ^^^^^^^^^^^^^^^^^^^^ </code></pre> __END__
clippy: crates/disassemble/src/lib.rs#L1
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for the crate --> crates/disassemble/src/lib.rs:1:1 | 1 | / mod error; 2 | | 3 | | mod core; 4 | | mod interfaces; ... | 8 | | pub use error::Error; 9 | | pub use interfaces::{DisassemblerArgs, DisassemblerArgsBuilder}; | |________________________________________________________________^ | = note: requested on the command line with `-W missing-docs` </code></pre> Raw Output: crates/disassemble/src/lib.rs:1:1:w: <pre><code>warning: missing documentation for the crate --> crates/disassemble/src/lib.rs:1:1 | 1 | / mod error; 2 | | 3 | | mod core; 4 | | mod interfaces; ... | 8 | | pub use error::Error; 9 | | pub use interfaces::{DisassemblerArgs, DisassemblerArgsBuilder}; | |________________________________________________________________^ | = note: requested on the command line with `-W missing-docs` </code></pre> __END__
clippy: crates/disassemble/src/error.rs#L2
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for an enum --> crates/disassemble/src/error.rs:2:1 | 2 | pub enum Error { | ^^^^^^^^^^^^^^ </code></pre> Raw Output: crates/disassemble/src/error.rs:2:1:w: <pre><code>warning: missing documentation for an enum --> crates/disassemble/src/error.rs:2:1 | 2 | pub enum Error { | ^^^^^^^^^^^^^^ </code></pre> __END__
clippy: crates/disassemble/src/error.rs#L4
[clippy] reported by reviewdog 🐶 <pre><code>warning: missing documentation for a variant --> crates/disassemble/src/error.rs:4:5 | 4 | Eyre(#[from] eyre::Report), | ^^^^ </code></pre> Raw Output: crates/disassemble/src/error.rs:4:5:w: <pre><code>warning: missing documentation for a variant --> crates/disassemble/src/error.rs:4:5 | 4 | Eyre(#[from] eyre::Report), | ^^^^ </code></pre> __END__