Skip to content

Improve docs & codecov for 0.5.0 #57

Improve docs & codecov for 0.5.0

Improve docs & codecov for 0.5.0 #57

GitHub Actions / clippy failed Jul 5, 2024 in 0s

reviewdog [clippy] report

reported by reviewdog 🐶

Findings (3)

src/token.rs|355 col 5| warning: missing documentation for a method
--> src/token.rs:355:5
|
355 | pub fn into_components(self) -> crate::Components<'t> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> src/lib.rs:2:9
|
2 | #![warn(missing_docs)]
| ^^^^^^^^^^^^
src/component.rs|3 col 1| warning: missing documentation for an enum
--> src/component.rs:3:1
|
3 | pub enum Component<'t> {
| ^^^^^^^^^^^^^^^^^^^^^^
src/component.rs|15 col 1| warning: missing documentation for a struct
--> src/component.rs:15:1
|
15 | pub struct Components<'t> {
| ^^^^^^^^^^^^^^^^^^^^^^^^^

Filtered Findings (3)

src/assign.rs|22 col 5| error: doc list item missing indentation
--> src/assign.rs:22:5
|
22 | //! be considered an index of an array.
| ^
|
= 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: the lint level is defined here
--> src/lib.rs:3:9
|
3 | #![deny(clippy::all, clippy::pedantic)]
| ^^^^^^^^^^^
= note: #[deny(clippy::doc_lazy_continuation)] implied by #[deny(clippy::all)]
help: indent this line
|
22 | //! be considered an index of an array.
| +
src/assign.rs|66 col 5| error: doc list item missing indentation
--> src/assign.rs:66:5
|
66 | /// be considered an index of an array.
| ^
|
= 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
|
66 | /// be considered an index of an array.
| +
src/index.rs|127 col 9| error: doc list item missing indentation
--> src/index.rs:127:9
|
127 | /// valid as well.
| ^
|
= 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
|
127 | /// valid as well.
| ++

Annotations

Check warning on line 355 in src/token.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

[clippy] src/token.rs#L355

warning: missing documentation for a method
   --> src/token.rs:355:5
    |
355 |     pub fn into_components(self) -> crate::Components<'t> {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
note: the lint level is defined here
   --> src/lib.rs:2:9
    |
2   | #![warn(missing_docs)]
    |         ^^^^^^^^^^^^
Raw output
src/token.rs:355:5:w:warning: missing documentation for a method
   --> src/token.rs:355:5
    |
355 |     pub fn into_components(self) -> crate::Components<'t> {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
note: the lint level is defined here
   --> src/lib.rs:2:9
    |
2   | #![warn(missing_docs)]
    |         ^^^^^^^^^^^^


__END__

Check warning on line 3 in src/component.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

[clippy] src/component.rs#L3

warning: missing documentation for an enum
 --> src/component.rs:3:1
  |
3 | pub enum Component<'t> {
  | ^^^^^^^^^^^^^^^^^^^^^^
Raw output
src/component.rs:3:1:w:warning: missing documentation for an enum
 --> src/component.rs:3:1
  |
3 | pub enum Component<'t> {
  | ^^^^^^^^^^^^^^^^^^^^^^


__END__

Check warning on line 15 in src/component.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

[clippy] src/component.rs#L15

warning: missing documentation for a struct
  --> src/component.rs:15:1
   |
15 | pub struct Components<'t> {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^
Raw output
src/component.rs:15:1:w:warning: missing documentation for a struct
  --> src/component.rs:15:1
   |
15 | pub struct Components<'t> {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^


__END__