Skip to content

Commit 943c3bc

Browse files
authored
Add note about caveat for cfg(doc)
For example, we definitely wouldn't want to do this in libcore.
1 parent 8298da7 commit 943c3bc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

clippy_lints/src/doc/mod.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -539,11 +539,15 @@ declare_clippy_lint! {
539539
/// ### What it does
540540
/// Checks if included files in doc comments are included only for `cfg(doc)`.
541541
///
542-
/// ### Why is this bad?
542+
/// ### Why restrict this?
543543
/// These files are not useful for compilation but will still be included.
544544
/// Also, if any of these non-source code file is updated, it will trigger a
545545
/// recompilation.
546546
///
547+
/// Excluding this will currently result in the file being left out if
548+
/// the item's docs are inlined from another crate. This may be fixed in a
549+
/// future version of rustdoc.
550+
///
547551
/// ### Example
548552
/// ```ignore
549553
/// #![doc = include_str!("some_file.md")]
@@ -554,7 +558,7 @@ declare_clippy_lint! {
554558
/// ```
555559
#[clippy::version = "1.84.0"]
556560
pub DOC_INCLUDE_WITHOUT_CFG,
557-
pedantic,
561+
restriction,
558562
"check if files included in documentation are behind `cfg(doc)`"
559563
}
560564

0 commit comments

Comments
 (0)