Skip to content

Commit

Permalink
Enable clippy::doc_markdown, fix remaining issues. (#805)
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys committed Aug 8, 2024
1 parent dd52b12 commit 5d169ae
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 7 deletions.
2 changes: 1 addition & 1 deletion plot/src/key.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ pub enum Order {
// TODO XY position
#[derive(Clone, Copy)]
pub enum Position {
/// Inside the area surrounded by the four (BottomX, TopX, LeftY and RightY) axes
/// Inside the area surrounded by the four (Bottom X, Top X, Left Y and Right Y) axes
Inside(Vertical, Horizontal),
/// Outside of that area
Outside(Vertical, Horizontal),
Expand Down
4 changes: 1 addition & 3 deletions plot/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -361,14 +361,12 @@
//! }));
//! ```

#![deny(missing_docs)]
#![deny(clippy::doc_markdown, missing_docs)]
#![deny(warnings)]
#![deny(bare_trait_objects)]
// This lint has lots of false positives ATM, see
// https://github.com/Manishearth/rust-clippy/issues/761
#![allow(clippy::new_without_default)]
// False positives with images
#![allow(clippy::doc_markdown)]
#![allow(clippy::many_single_char_names)]

use std::borrow::Cow;
Expand Down
2 changes: 1 addition & 1 deletion src/bencher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ impl<'a, M: Measurement> Bencher<'a, M> {
self.iterated = false;
}

/// Convert this bencher into an AsyncBencher, which enables async/await support.
/// Convert this bencher into an [`AsyncBencher`], which enables async/await support.
#[cfg(feature = "async")]
pub fn to_async<'b, A: AsyncExecutor>(&'b mut self, runner: A) -> AsyncBencher<'a, 'b, A, M> {
AsyncBencher { b: self, runner }
Expand Down
2 changes: 1 addition & 1 deletion src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub enum Error {
inner: SerdeError,
},
#[cfg(feature = "csv_output")]
/// This API requires the following crate features to be activated: csv_output
/// This API requires the following crate features to be activated: `csv_output`
CsvError(CsvError),
}
impl fmt::Display for Error {
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
//! * Produces detailed charts, providing thorough understanding of your code's
//! performance behavior.

#![warn(missing_docs)]
#![warn(clippy::doc_markdown, missing_docs)]
#![warn(bare_trait_objects)]
#![allow(
clippy::just_underscores_and_digits, // Used in the stats code
Expand Down

0 comments on commit 5d169ae

Please sign in to comment.