Skip to content

chore(docs): polish landing page wording & examples (#90) #191

chore(docs): polish landing page wording & examples (#90)

chore(docs): polish landing page wording & examples (#90) #191

Triggered via push August 30, 2024 13:36
Status Success
Total duration 5m 2s
Artifacts

ci.yml

on: push
nightly / fmt
13s
nightly / fmt
clippy
1m 24s
clippy
ubuntu / stable / coverage
2m 14s
ubuntu / stable / coverage
Matrix: build
Fit to window
Zoom out
Zoom in

Annotations

92 warnings
more than 3 bools in a struct: crates/bulloak/src/scaffold.rs#L21
warning: more than 3 bools in a struct --> crates/bulloak/src/scaffold.rs:21:1 | 21 | / pub struct Scaffold { 22 | | /// The set of tree files to generate from. 23 | | /// 24 | | /// Each Solidity file will be named after its matching ... | 52 | | pub skip_modifiers: bool, 53 | | } | |_^ | = help: consider using a state machine or refactoring bools into two-variant enums = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#struct_excessive_bools = note: `-W clippy::struct-excessive-bools` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::struct_excessive_bools)]`
struct update has no effect, all the fields in the struct have already been specified: crates/bulloak/src/cli.rs#L40
warning: struct update has no effect, all the fields in the struct have already been specified --> crates/bulloak/src/cli.rs:40:19 | 40 | ..Self::default() | ^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_update = note: `-W clippy::needless-update` implied by `-W clippy::all` = help: to override `-W clippy::all` add `#[allow(clippy::needless_update)]`
calling `Scaffold::default()` is more clear than this expression: crates/bulloak/src/cli.rs#L28
warning: calling `Scaffold::default()` is more clear than this expression --> crates/bulloak/src/cli.rs:28:24 | 28 | Self::Scaffold(Default::default()) | ^^^^^^^^^^^^^^^^^^ help: try: `Scaffold::default()` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#default_trait_access = note: `-W clippy::default-trait-access` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::default_trait_access)]`
you should put bare URLs between `<`/`>` or make a proper Markdown link: crates/bulloak/src/../README.md#L366
warning: you should put bare URLs between `<`/`>` or make a proper Markdown link --> crates/bulloak/src/../README.md:366:3 | 366 | https://opensource.org/licenses/MIT). | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `<https://opensource.org/licenses/MIT>` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
you should put bare URLs between `<`/`>` or make a proper Markdown link: crates/bulloak/src/../README.md#L364
warning: you should put bare URLs between `<`/`>` or make a proper Markdown link --> crates/bulloak/src/../README.md:364:3 | 364 | https://www.apache.org/licenses/LICENSE-2.0). | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `<https://www.apache.org/licenses/LICENSE-2.0>` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
item in documentation is missing backticks: crates/bulloak/src/../README.md#L32
warning: item in documentation is missing backticks --> crates/bulloak/src/../README.md:32:15 | 32 | The following VSCode extensions are not essential but they are recommended for a | ^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown help: try | 32 | The following `VSCode` extensions are not essential but they are recommended for a | ~~~~~~~~
item in documentation is missing backticks: crates/bulloak/src/../README.md#L30
warning: item in documentation is missing backticks --> crates/bulloak/src/../README.md:30:5 | 30 | ### VSCode | ^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown help: try | 30 | ### `VSCode` | ~~~~~~~~
item in documentation is missing backticks: crates/bulloak/src/../README.md#L7
warning: item in documentation is missing backticks --> crates/bulloak/src/../README.md:7:6 | 7 | - [VSCode](#vscode) | ^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown = note: `-W clippy::doc-markdown` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::doc_markdown)]` help: try | 7 | - [`VSCode`](#vscode) | ~~~~~~~~
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/scaffold/mod.rs#L17
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/scaffold/mod.rs:17:1 | 17 | pub fn scaffold(text: &str, cfg: &Config) -> anyhow::Result<String> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function which may panic missing `# Panics` section: crates/foundry/src/scaffold/mod.rs#L17
warning: docs for function which may panic missing `# Panics` section --> crates/foundry/src/scaffold/mod.rs:17:1 | 17 | pub fn scaffold(text: &str, cfg: &Config) -> anyhow::Result<String> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | note: first possible panic found here --> crates/foundry/src/scaffold/mod.rs:22:9 | 22 | fmt(&source).expect("should format the emitted solidity code"); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc
docs for function which may panic missing `# Panics` section: crates/foundry/src/scaffold/modifiers.rs#L38
warning: docs for function which may panic missing `# Panics` section --> crates/foundry/src/scaffold/modifiers.rs:38:5 | 38 | pub fn discover(&mut self, ast: &Ast) -> &IndexMap<String, String> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | note: first possible panic found here --> crates/foundry/src/scaffold/modifiers.rs:41:17 | 41 | self.visit_root(root).unwrap(); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc
unused `self` argument: crates/foundry/src/scaffold/emitter.rs#L91
warning: unused `self` argument --> crates/foundry/src/scaffold/emitter.rs:91:9 | 91 | &self, | ^^^^^ | = help: consider refactoring to an associated function = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unused_self = note: `-W clippy::unused-self` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::unused_self)]`
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/mod.rs#L26
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/mod.rs:26:1 | 26 | pub fn translate(text: &str, cfg: &Config) -> anyhow::Result<Hir> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/visitor.rs#L82
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/visitor.rs:82:5 | 82 | / fn visit_statement( 83 | | &mut self, 84 | | statement: &hir::Statement, 85 | | ) -> Result<Self::StatementOutput, Self::Error>; | |____________________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/visitor.rs#L70
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/visitor.rs:70:5 | 70 | / fn visit_comment( 71 | | &mut self, 72 | | comment: &hir::Comment, 73 | | ) -> Result<Self::CommentOutput, Self::Error>; | |__________________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/visitor.rs#L56
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/visitor.rs:56:5 | 56 | / fn visit_function( 57 | | &mut self, 58 | | function: &hir::FunctionDefinition, 59 | | ) -> Result<Self::FunctionDefinitionOutput, Self::Error>; | |_____________________________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/visitor.rs#L44
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/visitor.rs:44:5 | 44 | / fn visit_contract( 45 | | &mut self, 46 | | contract: &hir::ContractDefinition, 47 | | ) -> Result<Self::ContractDefinitionOutput, Self::Error>; | |_____________________________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/visitor.rs#L32
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/visitor.rs:32:5 | 32 | / fn visit_root( 33 | | &mut self, 34 | | root: &hir::Root, 35 | | ) -> Result<Self::RootOutput, Self::Error>; | |_______________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/hir/combiner.rs#L99
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/hir/combiner.rs:99:5 | 99 | / pub fn combine( 100 | | self, 101 | | text: &str, 102 | | hirs: impl Iterator<Item = Hir>, 103 | | ) -> Result<Hir> { | |____________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
you seem to be trying to use `&Box<T>`. Consider using just `&T`: crates/foundry/src/check/violation.rs#L308
warning: you seem to be trying to use `&Box<T>`. Consider using just `&T` --> crates/foundry/src/check/violation.rs:308:19 | 308 | contract_sol: &Box<ContractDefinition>, | ^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `&ContractDefinition` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#borrowed_box = note: `-W clippy::borrowed-box` implied by `-W clippy::all` = help: to override `-W clippy::all` add `#[allow(clippy::borrowed_box)]`
this method could have a `#[must_use]` attribute: crates/foundry/src/check/violation.rs#L174
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/violation.rs:174:5 | 174 | pub fn fix(&self, mut ctx: Context) -> Context { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn fix(&self, mut ctx: Context) -> Context` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
docs for function which may panic missing `# Panics` section: crates/foundry/src/check/violation.rs#L174
warning: docs for function which may panic missing `# Panics` section --> crates/foundry/src/check/violation.rs:174:5 | 174 | pub fn fix(&self, mut ctx: Context) -> Context { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | note: first possible panic found here --> crates/foundry/src/check/violation.rs:181:21 | 181 | parse(&source).expect("should parse Solidity string"); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc = note: `-W clippy::missing-panics-doc` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::missing_panics_doc)]`
this method could have a `#[must_use]` attribute: crates/foundry/src/check/violation.rs#L151
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/violation.rs:151:5 | 151 | pub fn help(&self) -> Option<Cow<'static, str>> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn help(&self) -> Option<Cow<'static, str>>` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this method could have a `#[must_use]` attribute: crates/foundry/src/check/violation.rs#L139
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/violation.rs:139:5 | 139 | pub fn is_fixable(&self) -> bool { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn is_fixable(&self) -> bool` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
item name starts with its containing module's name: crates/foundry/src/check/violation.rs#L54
warning: item name starts with its containing module's name --> crates/foundry/src/check/violation.rs:54:10 | 54 | pub enum ViolationKind { | ^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#module_name_repetitions = note: `-W clippy::module-name-repetitions` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::module_name_repetitions)]`
this method could have a `#[must_use]` attribute: crates/foundry/src/check/violation.rs#L41
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/violation.rs:41:5 | 41 | pub fn is_fixable(&self) -> bool { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn is_fixable(&self) -> bool` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this method could have a `#[must_use]` attribute: crates/foundry/src/check/violation.rs#L36
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/violation.rs:36:5 | 36 | pub fn new(kind: ViolationKind, location: Location) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn new(kind: ViolationKind, location: Location) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this function could have a `#[must_use]` attribute: crates/foundry/src/check/utils.rs#L22
warning: this function could have a `#[must_use]` attribute --> crates/foundry/src/check/utils.rs:22:1 | 22 | pub fn offset_to_line(content: &str, start: usize) -> usize { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn offset_to_line(content: &str, start: usize) -> usize` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this function could have a `#[must_use]` attribute: crates/foundry/src/check/utils.rs#L4
warning: this function could have a `#[must_use]` attribute --> crates/foundry/src/check/utils.rs:4:1 | 4 | pub fn offset_to_line_column(content: &str, start: usize) -> (usize, usize) { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn offset_to_line_column(content: &str, start: usize) -> (usize, usize)` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
the loop variable `j` is only used to index `present_fn_indices`: crates/foundry/src/check/rules/structural_match.rs#L179
warning: the loop variable `j` is only used to index `present_fn_indices` --> crates/foundry/src/check/rules/structural_match.rs:179:18 | 179 | for j in i + 1..present_fn_indices.len() { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_range_loop = note: `-W clippy::needless-range-loop` implied by `-W clippy::all` = help: to override `-W clippy::all` add `#[allow(clippy::needless_range_loop)]` help: consider using an iterator | 179 | for <item> in present_fn_indices.iter().skip(i + 1) { | ~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
consider adding a `;` to the last statement for consistent formatting: crates/foundry/src/check/rules/structural_match.rs#L151
warning: consider adding a `;` to the last statement for consistent formatting --> crates/foundry/src/check/rules/structural_match.rs:151:21 | 151 | / violations.push(Violation::new( 152 | | ViolationKind::MatchingFunctionMissing( 153 | | fn_hir.clone(), 154 | | hir_idx, ... | 159 | | ), 160 | | )) | |______________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#semicolon_if_nothing_returned help: add a `;` here | 151 ~ violations.push(Violation::new( 152 + ViolationKind::MatchingFunctionMissing( 153 + fn_hir.clone(), 154 + hir_idx, 155 + ), 156 + Location::Code( 157 + ctx.tree.to_string_lossy().into_owned(), 158 + fn_hir.span.start.line, 159 + ), 160 + )); |
consider adding a `;` to the last statement for consistent formatting: crates/foundry/src/check/rules/structural_match.rs#L142
warning: consider adding a `;` to the last statement for consistent formatting --> crates/foundry/src/check/rules/structural_match.rs:142:21 | 142 | present_fn_indices.push((hir_idx, sol_idx)) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add a `;` here: `present_fn_indices.push((hir_idx, sol_idx));` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#semicolon_if_nothing_returned = note: `-W clippy::semicolon-if-nothing-returned` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::semicolon_if_nothing_returned)]`
you seem to be trying to use `match` for destructuring a single pattern. Consider using `if let`: crates/foundry/src/check/rules/structural_match.rs#L138
warning: you seem to be trying to use `match` for destructuring a single pattern. Consider using `if let` --> crates/foundry/src/check/rules/structural_match.rs:138:13 | 138 | / match fn_sol { 139 | | // Store the matched function to check it is at the 140 | | // appropriate place later. 141 | | Some((sol_idx, _)) => { ... | 161 | | } 162 | | } | |_____________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#single_match_else = note: `-W clippy::single-match-else` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::single_match_else)]` help: try | 138 ~ if let Some((sol_idx, _)) = fn_sol { 139 + present_fn_indices.push((hir_idx, sol_idx)) 140 + } else { 141 + if ctx.cfg.skip_modifiers && fn_hir.is_modifier() { 142 + continue; 143 + } 144 + 145 + violations.push(Violation::new( 146 + ViolationKind::MatchingFunctionMissing( 147 + fn_hir.clone(), 148 + hir_idx, 149 + ), 150 + Location::Code( 151 + ctx.tree.to_string_lossy().into_owned(), 152 + fn_hir.span.start.line, 153 + ), 154 + )) 155 + } |
doc list item missing indentation: crates/foundry/src/check/rules/structural_match.rs#L12
warning: doc list item missing indentation --> crates/foundry/src/check/rules/structural_match.rs:12:5 | 12 | //! and modifiers are supported. | ^ | = 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 | 12 | //! and modifiers are supported. | ++
this method could have a `#[must_use]` attribute: crates/foundry/src/check/location.rs#L18
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/location.rs:18:5 | 18 | pub fn file(&self) -> String { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn file(&self) -> String` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/check/context.rs#L92
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/check/context.rs:92:5 | 92 | pub fn fmt(self) -> anyhow::Result<String, FormatterError> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
missing `#[must_use]` attribute on a method returning `Self`: crates/foundry/src/check/context.rs#L83
warning: missing `#[must_use]` attribute on a method returning `Self` --> crates/foundry/src/check/context.rs:83:5 | 83 | / pub fn from_parsed(mut self, parsed: Parsed) -> Self { 84 | | parsed.src.clone_into(&mut self.src); 85 | | self.pt = parsed.pt; 86 | | self.comments = parsed.comments; 87 | | self 88 | | } | |_____^ | = help: consider adding the `#[must_use]` attribute to the method or directly to the `Self` type = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#return_self_not_must_use = note: `-W clippy::return-self-not-must-use` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::return_self_not_must_use)]`
this method could have a `#[must_use]` attribute: crates/foundry/src/check/context.rs#L83
warning: this method could have a `#[must_use]` attribute --> crates/foundry/src/check/context.rs:83:5 | 83 | pub fn from_parsed(mut self, parsed: Parsed) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn from_parsed(mut self, parsed: Parsed) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate = note: `-W clippy::must-use-candidate` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::must_use_candidate)]`
docs for function returning `Result` missing `# Errors` section: crates/foundry/src/check/context.rs#L53
warning: docs for function returning `Result` missing `# Errors` section --> crates/foundry/src/check/context.rs:53:5 | 53 | pub fn new(tree: PathBuf, cfg: &Config) -> Result<Self, Violation> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc = note: `-W clippy::missing-errors-doc` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::missing_errors_doc)]`
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/lib.rs#L29
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/lib.rs:29:1 | 29 | pub fn parse_one(text: &str) -> anyhow::Result<ast::Ast> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/lib.rs#L24
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/lib.rs:24:1 | 24 | pub fn parse(text: &str) -> anyhow::Result<Vec<ast::Ast>> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/visitor.rs#L32
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/visitor.rs:32:5 | 32 | / fn visit_description( 33 | | &mut self, 34 | | description: &ast::Description, 35 | | ) -> Result<Self::Output, Self::Error>; | |___________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/visitor.rs#L27
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/visitor.rs:27:5 | 27 | / fn visit_action( 28 | | &mut self, 29 | | action: &ast::Action, 30 | | ) -> Result<Self::Output, Self::Error>; | |___________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/visitor.rs#L22
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/visitor.rs:22:5 | 22 | / fn visit_condition( 23 | | &mut self, 24 | | condition: &ast::Condition, 25 | | ) -> Result<Self::Output, Self::Error>; | |___________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/visitor.rs#L17
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/visitor.rs:17:5 | 17 | / fn visit_root( 18 | | &mut self, 19 | | root: &ast::Root, 20 | | ) -> Result<Self::Output, Self::Error>; | |___________________________________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
this function could have a `#[must_use]` attribute: crates/syntax/src/utils.rs#L154
warning: this function could have a `#[must_use]` attribute --> crates/syntax/src/utils.rs:154:1 | 154 | / pub fn pluralize<'a>( 155 | | count: usize, 156 | | singular: &'a str, 157 | | plural: &'a str, 158 | | ) -> &'a str { | |____________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate help: add the attribute | 154 + #[must_use] pub fn pluralize<'a>( 155 + count: usize, 156 + singular: &'a str, 157 + plural: &'a str, 158 ~ ) -> &'a str { |
this function could have a `#[must_use]` attribute: crates/syntax/src/utils.rs#L131
warning: this function could have a `#[must_use]` attribute --> crates/syntax/src/utils.rs:131:1 | 131 | pub fn repeat_str(s: &str, n: usize) -> String { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn repeat_str(s: &str, n: usize) -> String` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this function could have a `#[must_use]` attribute: crates/syntax/src/utils.rs#L82
warning: this function could have a `#[must_use]` attribute --> crates/syntax/src/utils.rs:82:1 | 82 | pub fn sanitize(identifier: &str) -> String { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub fn sanitize(identifier: &str) -> String` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this method could have a `#[must_use]` attribute: crates/syntax/src/span.rs#L114
warning: this method could have a `#[must_use]` attribute --> crates/syntax/src/span.rs:114:5 | 114 | pub const fn new(offset: usize, line: usize, column: usize) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub const fn new(offset: usize, line: usize, column: usize) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
missing `#[must_use]` attribute on a method returning `Self`: crates/syntax/src/span.rs#L100
warning: missing `#[must_use]` attribute on a method returning `Self` --> crates/syntax/src/span.rs:100:5 | 100 | / pub const fn with_end(self, pos: Position) -> Self { 101 | | Self { end: pos, ..self } 102 | | } | |_____^ | = help: consider adding the `#[must_use]` attribute to the method or directly to the `Self` type = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#return_self_not_must_use
this method could have a `#[must_use]` attribute: crates/syntax/src/span.rs#L100
warning: this method could have a `#[must_use]` attribute --> crates/syntax/src/span.rs:100:5 | 100 | pub const fn with_end(self, pos: Position) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub const fn with_end(self, pos: Position) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
missing `#[must_use]` attribute on a method returning `Self`: crates/syntax/src/span.rs#L94
warning: missing `#[must_use]` attribute on a method returning `Self` --> crates/syntax/src/span.rs:94:5 | 94 | / pub const fn with_start(self, pos: Position) -> Self { 95 | | Self { start: pos, ..self } 96 | | } | |_____^ | = help: consider adding the `#[must_use]` attribute to the method or directly to the `Self` type = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#return_self_not_must_use = note: `-W clippy::return-self-not-must-use` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::return_self_not_must_use)]`
this method could have a `#[must_use]` attribute: crates/syntax/src/span.rs#L94
warning: this method could have a `#[must_use]` attribute --> crates/syntax/src/span.rs:94:5 | 94 | pub const fn with_start(self, pos: Position) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub const fn with_start(self, pos: Position) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this method could have a `#[must_use]` attribute: crates/syntax/src/span.rs#L88
warning: this method could have a `#[must_use]` attribute --> crates/syntax/src/span.rs:88:5 | 88 | pub const fn splat(pos: Position) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub const fn splat(pos: Position) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate
this method could have a `#[must_use]` attribute: crates/syntax/src/span.rs#L83
warning: this method could have a `#[must_use]` attribute --> crates/syntax/src/span.rs:83:5 | 83 | pub const fn new(start: Position, end: Position) -> Self { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: add the attribute: `#[must_use] pub const fn new(start: Position, end: Position) -> Self` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#must_use_candidate = note: `-W clippy::must-use-candidate` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::must_use_candidate)]`
redundant closure: crates/syntax/src/semantics.rs#L18
warning: redundant closure --> crates/syntax/src/semantics.rs:18:29 | 18 | #[error("{}", .0.iter().map(|e| e.to_string()).collect::<Vec<_>>().join(""))] | ^^^^^^^^^^^^^^^^^ help: replace the closure with the method itself: `std::string::ToString::to_string` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#redundant_closure_for_method_calls = note: `-W clippy::redundant-closure-for-method-calls` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::redundant_closure_for_method_calls)]`
called `.collect::<Vec<String>>().join("")` on an iterator: crates/syntax/src/semantics.rs#L18
warning: called `.collect::<Vec<String>>().join("")` on an iterator --> crates/syntax/src/semantics.rs:18:48 | 18 | #[error("{}", .0.iter().map(|e| e.to_string()).collect::<Vec<_>>().join(""))] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `collect::<String>()` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_join = note: `-W clippy::unnecessary-join` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::unnecessary_join)]`
docs for function returning `Result` missing `# Errors` section: crates/syntax/src/error.rs#L33
warning: docs for function returning `Result` missing `# Errors` section --> crates/syntax/src/error.rs:33:5 | 33 | fn format_error(&self, f: &mut fmt::Formatter<'_>) -> std::fmt::Result { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc = note: `-W clippy::missing-errors-doc` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::missing_errors_doc)]`
item name ends with its containing module's name: crates/syntax/src/error.rs#L9
warning: item name ends with its containing module's name --> crates/syntax/src/error.rs:9:11 | 9 | pub trait FrontendError<K: fmt::Display>: std::error::Error { | ^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#module_name_repetitions = note: `-W clippy::module-name-repetitions` implied by `-W clippy::pedantic` = help: to override `-W clippy::pedantic` add `#[allow(clippy::module_name_repetitions)]`
clippy
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
clippy
The following actions use a deprecated Node.js version and will be forced to run on node20: actions-rs/toolchain@v1, actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
clippy
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
clippy
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
clippy
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
clippy
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (macOS-latest)
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
build (macOS-latest)
The following actions use a deprecated Node.js version and will be forced to run on node20: actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
build (macOS-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (macOS-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (macOS-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (macOS-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (macOS-latest): crates/bulloak/benches/bench.rs#L1
missing documentation for the crate
build (macOS-latest): crates/bulloak/benches/bench.rs#L16
missing documentation for a function
build (macOS-latest)
`bulloak` (bench "bench") generated 2 warnings
build (ubuntu-latest)
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
build (ubuntu-latest)
The following actions use a deprecated Node.js version and will be forced to run on node20: actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
build (ubuntu-latest): crates/bulloak/benches/bench.rs#L1
missing documentation for the crate
build (ubuntu-latest): crates/bulloak/benches/bench.rs#L16
missing documentation for a function
build (ubuntu-latest)
`bulloak` (bench "bench") generated 2 warnings
build (ubuntu-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (ubuntu-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (ubuntu-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (ubuntu-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (windows-latest)
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
build (windows-latest)
The following actions use a deprecated Node.js version and will be forced to run on node20: actions-rs/toolchain@v1, actions-rs/cargo@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
build (windows-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (windows-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (windows-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (windows-latest)
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
build (windows-latest): crates/bulloak/benches/bench.rs#L1
missing documentation for the crate
build (windows-latest): crates/bulloak/benches/bench.rs#L16
missing documentation for a function
build (windows-latest)
`bulloak` (bench "bench") generated 2 warnings