diff --git a/plot/src/key.rs b/plot/src/key.rs index e8847d69..b5d80683 100644 --- a/plot/src/key.rs +++ b/plot/src/key.rs @@ -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), diff --git a/plot/src/lib.rs b/plot/src/lib.rs index a948defb..7ddbb3be 100644 --- a/plot/src/lib.rs +++ b/plot/src/lib.rs @@ -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)] extern crate cast; diff --git a/src/bencher.rs b/src/bencher.rs index 6694d281..369c1ce8 100644 --- a/src/bencher.rs +++ b/src/bencher.rs @@ -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 } diff --git a/src/error.rs b/src/error.rs index 459a716f..6c559c68 100644 --- a/src/error.rs +++ b/src/error.rs @@ -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 { diff --git a/src/lib.rs b/src/lib.rs index 547d9904..0371db49 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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