Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable clippy::doc_markdown, fix remaining issues. #805

Merged
merged 1 commit into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)]

extern crate cast;
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