Is it possible to run clippy on code in rustdoc examples

jmcnamara · April 5, 2023, 12:40pm

It is possible (and useful) to run clippy with --tests, --examples and --all-targets but from testing none of those lint the code in rustdoc examples.

Is it possible to run clippy on code in rustdoc examples?

jofas · April 5, 2023, 3:16pm

No, AFAIK this is impossible, see this issue:

github.com/rust-lang/rust

Oh rust doctest lints, where art þou? (Add a way to run clippy on doctests)

opened 11:32AM - 26 Nov 18 UTC

llogiq

T-rustdoc A-lint A-doctests A-clippy

Currently, doctests benefit from being code in numerous ways, such as being test…ed. However, this unfortunately does not (yet?) apply to clippy lints. For (an atmittedly contrived) example: ```rust /// is the given number odd? /// /// # Examples /// /// ```rust ///# use testdoclints::is_odd; /// let mut a = 1; /// a = a + 1; // this should lint `clippy::assign_op_pattern` /// assert!(!is_odd(a)); /// ``` pub fn is_odd(x: usize) -> bool { (x & 1) == 1 } ``` Running `cargo clippy` shows no lint. To solve this, we'd need to be able to hook into the test code generation and present the resulting AST and HIR to our lints. I am unsure where to put this issue, but as clippy is not the only source of custom lints, I think solving it within rust/rustdoc makes sense. cc @Manishearth @oli-obk

I agree that it would be great if clippy and rustfmt would apply to doctests as well.

jmcnamara · April 5, 2023, 7:35pm

Thanks for that link. There is a script at the end of that thread that does what I need with cargo +nightly: cargo-rustdoc-clippy.

system · July 4, 2023, 7:36pm

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.