chore: documentation and linting overhaul #709
Annotations
2 errors and 11 warnings
|
Run giraffate/clippy-action@v1
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
|
|
Run giraffate/clippy-action@v1
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
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L1
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for the crate
--> crates/cache/src/lib.rs:1:1
|
1 | / use clap::Parser;
2 | | use serde::{de::DeserializeOwned, Deserialize, Serialize};
3 | | #[allow(deprecated)]
4 | | use std::env::home_dir;
... |
468 | | }
469 | | }
| |_^
|
= note: requested on the command line with `-W missing-docs`
</code></pre>
Raw Output:
crates/cache/src/lib.rs:1:1:w:
<pre><code>warning: missing documentation for the crate
--> crates/cache/src/lib.rs:1:1
|
1 | / use clap::Parser;
2 | | use serde::{de::DeserializeOwned, Deserialize, Serialize};
3 | | #[allow(deprecated)]
4 | | use std::env::home_dir;
... |
468 | | }
469 | | }
| |_^
|
= note: requested on the command line with `-W missing-docs`
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L9
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a module
--> crates/cache/src/lib.rs:9:1
|
9 | pub mod error;
| ^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:9:1:w:
<pre><code>warning: missing documentation for a module
--> crates/cache/src/lib.rs:9:1
|
9 | pub mod error;
| ^^^^^^^^^^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L21
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/cache/src/lib.rs:21:5
|
21 | pub sub: Subcommands,
| ^^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:21:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/cache/src/lib.rs:21:5
|
21 | pub sub: Subcommands,
| ^^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L37
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/lib.rs:37:5
|
37 | Clean(NoArguments),
| ^^^^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:37:5:w:
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/lib.rs:37:5
|
37 | Clean(NoArguments),
| ^^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L40
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/lib.rs:40:5
|
40 | Ls(NoArguments),
| ^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:40:5:w:
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/lib.rs:40:5
|
40 | Ls(NoArguments),
| ^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L43
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/lib.rs:43:5
|
43 | Size(NoArguments),
| ^^^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:43:5:w:
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/lib.rs:43:5
|
43 | Size(NoArguments),
| ^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L50
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/cache/src/lib.rs:50:5
|
50 | pub value: T,
| ^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:50:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/cache/src/lib.rs:50:5
|
50 | pub value: T,
| ^^^^^^^^^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/lib.rs#L51
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/cache/src/lib.rs:51:5
|
51 | pub expiry: u64,
| ^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/cache/src/lib.rs:51:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/cache/src/lib.rs:51:5
|
51 | pub expiry: u64,
| ^^^^^^^^^^^^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/error.rs#L2
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for an enum
--> crates/cache/src/error.rs:2:1
|
2 | pub enum Error {
| ^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/cache/src/error.rs:2:1:w:
<pre><code>warning: missing documentation for an enum
--> crates/cache/src/error.rs:2:1
|
2 | pub enum Error {
| ^^^^^^^^^^^^^^
</code></pre>
__END__
|
|
Run giraffate/clippy-action@v1:
crates/cache/src/error.rs#L4
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/error.rs:4:5
|
4 | Generic(String),
| ^^^^^^^
</code></pre>
Raw Output:
crates/cache/src/error.rs:4:5:w:
<pre><code>warning: missing documentation for a variant
--> crates/cache/src/error.rs:4:5
|
4 | Generic(String),
| ^^^^^^^
</code></pre>
__END__
|
Loading