bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Add note about caveat for cfg(doc)

Browse source 
For example, we definitely wouldn't want to do this in libcore.
This commit is contained in:
Michael Howell 2024-11-23 17:10:08 -07:00 • committed by GitHub
parent 8298da72e7
commit 943c3bc3db
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
clippy_lints/src/doc/mod.rs
View file

@ -539,11 +539,15 @@ declare_clippy_lint! {
/// ### What it does /// ### What it does
/// Checks if included files in doc comments are included only for `cfg(doc)`. /// Checks if included files in doc comments are included only for `cfg(doc)`.
/// ///
/// ### Why is this bad? /// ### Why restrict this?
/// These files are not useful for compilation but will still be included. /// These files are not useful for compilation but will still be included.
/// Also, if any of these non-source code file is updated, it will trigger a /// Also, if any of these non-source code file is updated, it will trigger a
/// recompilation. /// recompilation.
/// ///
/// Excluding this will currently result in the file being left out if
/// the item's docs are inlined from another crate. This may be fixed in a
/// future version of rustdoc.
///
/// ### Example /// ### Example
/// ```ignore /// ```ignore
/// #![doc = include_str!("some_file.md")] /// #![doc = include_str!("some_file.md")]
@ -554,7 +558,7 @@ declare_clippy_lint! {
/// ``` /// ```
#[clippy::version = "1.84.0"] #[clippy::version = "1.84.0"]
pub DOC_INCLUDE_WITHOUT_CFG, pub DOC_INCLUDE_WITHOUT_CFG,
pedantic, restriction,
"check if files included in documentation are behind `cfg(doc)`" "check if files included in documentation are behind `cfg(doc)`"
} }