Rollup merge of #101536 - GuillaumeGomez:is_doc_comment-doc, r=lqd

Add documentation for Attr::is_doc_comment The function name is very misleading, some explanations won't hurt. r? `@lqd`
rust-lang · Sep 7, 2022 · 41e1830 · 41e1830
2 parents 497e170 + 88fa621
commit 41e1830
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/compiler/rustc_ast/src/attr/mod.rs b/compiler/rustc_ast/src/attr/mod.rs
@@ -232,6 +232,8 @@ impl AttrItem {
 }
 
 impl Attribute {
+    /// Returns `true` if it is a sugared doc comment (`///` or `//!` for example).
+    /// So `#[doc = "doc"]` will return `false`.
     pub fn is_doc_comment(&self) -> bool {
         match self.kind {
             AttrKind::Normal(..) => false,