File tree 1 file changed +8
-2
lines changed
1 file changed +8
-2
lines changed Original file line number Diff line number Diff line change @@ -539,11 +539,17 @@ declare_clippy_lint! {
539
539
/// ### What it does
540
540
/// Checks if included files in doc comments are included only for `cfg(doc)`.
541
541
///
542
- /// ### Why is this bad ?
542
+ /// ### Why restrict this?
543
543
/// These files are not useful for compilation but will still be included.
544
544
/// Also, if any of these non-source code file is updated, it will trigger a
545
545
/// recompilation.
546
546
///
547
+ /// ### Known problems
548
+ ///
549
+ /// Excluding this will currently result in the file being left out if
550
+ /// the item's docs are inlined from another crate. This may be fixed in a
551
+ /// future version of rustdoc.
552
+ ///
547
553
/// ### Example
548
554
/// ```ignore
549
555
/// #![doc = include_str!("some_file.md")]
@@ -554,7 +560,7 @@ declare_clippy_lint! {
554
560
/// ```
555
561
#[ clippy:: version = "1.84.0" ]
556
562
pub DOC_INCLUDE_WITHOUT_CFG ,
557
- pedantic ,
563
+ restriction ,
558
564
"check if files included in documentation are behind `cfg(doc)`"
559
565
}
560
566
You can’t perform that action at this time.
0 commit comments