Skip to content

Commit

Permalink
Ignore clippy::too_long_first_doc_paragraph lint
Browse files Browse the repository at this point in the history
```
error: first doc comment paragraph is too long
   --> tools/codegen/src/lib.rs:314:1
    |
314 | / /// GitHub Actions Runner supports Linux (x86_64, aarch64, arm), Windows (x86_64, aarch64),
315 | | /// and macOS (x86_64, aarch64).
316 | | /// https://github.com/actions/runner/blob/v2.315.0/.github/workflows/build.yml#L21
317 | | /// https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners#supported-architectures-and-operating-systems-f...
318 | | ///
319 | | /// Note:
    | |_
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
    = note: `-D clippy::too-long-first-doc-paragraph` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::too_long_first_doc_paragraph)]`
```
  • Loading branch information
taiki-e committed Aug 26, 2024
1 parent f172798 commit 7ea7a2c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions tools/codegen/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// SPDX-License-Identifier: Apache-2.0 OR MIT

#![allow(clippy::missing_panics_doc, clippy::too_long_first_doc_paragraph)]

use std::{
cmp::{self, Reverse},
collections::BTreeMap,
Expand Down Expand Up @@ -244,8 +246,6 @@ pub struct BaseManifest {
}
impl BaseManifest {
/// Validate the manifest.
// The panic is an assert
#[allow(clippy::missing_panics_doc)]
pub fn validate(&self) {
for bin in self.bin.iter().chain(self.platform.values().flat_map(|m| &m.bin)) {
assert!(!bin.as_slice().is_empty());
Expand Down

0 comments on commit 7ea7a2c

Please sign in to comment.