Skip to content

Commit

Permalink
Auto merge of #115851 - Alexendoo:clippy-doc-hidden-headers, r=flip1995
Browse files Browse the repository at this point in the history
Ignore `#[doc(hidden)]` functions in clippy doc lints

Fixes rust-lang/rust-clippy#11501

The implementation before #115689 had a check for unsugared doc comments that also happened to catch `#[doc(hidden)]`, this adds the check back in more explicitly

https://github.com/rust-lang/rust/blob/852bf4e51bf260550cd1a280d2146f1c0641b1e8/src/tools/clippy/clippy_lints/src/doc.rs#L526-L529

r? `@flip1995`
  • Loading branch information
bors committed Sep 15, 2023
2 parents 915c8af + 88f3f23 commit 56e1aaa
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
4 changes: 4 additions & 0 deletions src/tools/clippy/clippy_lints/src/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,10 @@ fn check_attrs(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, attrs: &[
Some(("fake".into(), "fake".into()))
}

if is_doc_hidden(attrs) {
return None;
}

let (fragments, _) = attrs_to_doc_fragments(attrs.iter().map(|attr| (attr, None)), true);
let mut doc = String::new();
for fragment in &fragments {
Expand Down
15 changes: 15 additions & 0 deletions src/tools/clippy/tests/ui/doc_errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ impl Struct1 {
fn block_comment_leading_asterisks() -> Result<(), ()> {
unimplemented!();
}

#[doc(hidden)]
fn doc_hidden() -> Result<(), ()> {
unimplemented!();
}
}

pub trait Trait1 {
Expand All @@ -111,6 +116,11 @@ pub trait Trait1 {
/// # Errors
/// A description of the errors goes here.
fn trait_method_with_errors_header() -> Result<(), ()>;

#[doc(hidden)]
fn doc_hidden() -> Result<(), ()> {
unimplemented!();
}
}

impl Trait1 for Struct1 {
Expand All @@ -123,6 +133,11 @@ impl Trait1 for Struct1 {
}
}

#[doc(hidden)]
pub trait DocHidden {
fn f() -> Result<(), ()>;
}

fn main() -> Result<(), ()> {
Ok(())
}
2 changes: 1 addition & 1 deletion src/tools/clippy/tests/ui/doc_errors.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ LL | pub async fn async_pub_method_missing_errors_header() -> Result<(), ()>
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: docs for function returning `Result` missing `# Errors` section
--> $DIR/doc_errors.rs:108:5
--> $DIR/doc_errors.rs:113:5
|
LL | fn trait_method_missing_errors_header() -> Result<(), ()>;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 56e1aaa

Please sign in to comment.