chore: documentation and linting overhaul #742
Annotations
2 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
|
clippy:
crates/config/src/lib.rs#L1
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for the crate
--> crates/config/src/lib.rs:1:1
|
1 | / pub mod error;
2 | |
3 | | use crate::error::Error;
4 | | use clap::Parser;
... |
291 | | }
292 | | }
| |_^
|
= note: requested on the command line with `-W missing-docs`
</code></pre>
Raw Output:
crates/config/src/lib.rs:1:1:w:
<pre><code>warning: missing documentation for the crate
--> crates/config/src/lib.rs:1:1
|
1 | / pub mod error;
2 | |
3 | | use crate::error::Error;
4 | | use clap::Parser;
... |
291 | | }
292 | | }
| |_^
|
= note: requested on the command line with `-W missing-docs`
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L1
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a module
--> crates/config/src/lib.rs:1:1
|
1 | pub mod error;
| ^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:1:1:w:
<pre><code>warning: missing documentation for a module
--> crates/config/src/lib.rs:1:1
|
1 | pub mod error;
| ^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L17
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct
--> crates/config/src/lib.rs:17:1
|
17 | pub struct ConfigArgs {
| ^^^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:17:1:w:
<pre><code>warning: missing documentation for a struct
--> crates/config/src/lib.rs:17:1
|
17 | pub struct ConfigArgs {
| ^^^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L31
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:31:5
|
31 | pub rpc_url: String,
| ^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:31:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:31:5
|
31 | pub rpc_url: String,
| ^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L32
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:32:5
|
32 | pub local_rpc_url: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:32:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:32:5
|
32 | pub local_rpc_url: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L33
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:33:5
|
33 | pub etherscan_api_key: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:33:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:33:5
|
33 | pub etherscan_api_key: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L34
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:34:5
|
34 | pub transpose_api_key: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:34:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:34:5
|
34 | pub transpose_api_key: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/lib.rs#L35
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:35:5
|
35 | pub openai_api_key: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/lib.rs:35:5:w:
<pre><code>warning: missing documentation for a struct field
--> crates/config/src/lib.rs:35:5
|
35 | pub openai_api_key: String,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/error.rs#L4
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for an enum
--> crates/config/src/error.rs:4:1
|
4 | pub enum Error {
| ^^^^^^^^^^^^^^
</code></pre>
Raw Output:
crates/config/src/error.rs:4:1:w:
<pre><code>warning: missing documentation for an enum
--> crates/config/src/error.rs:4:1
|
4 | pub enum Error {
| ^^^^^^^^^^^^^^
</code></pre>
__END__
|
clippy:
crates/config/src/error.rs#L6
[clippy] reported by reviewdog 🐶
<pre><code>warning: missing documentation for a variant
--> crates/config/src/error.rs:6:5
|
6 | Generic(String),
| ^^^^^^^
</code></pre>
Raw Output:
crates/config/src/error.rs:6:5:w:
<pre><code>warning: missing documentation for a variant
--> crates/config/src/error.rs:6:5
|
6 | Generic(String),
| ^^^^^^^
</code></pre>
__END__
|