Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make doc_unsafe warn on unsafe traits as well #7734

Merged
merged 2 commits into from
Sep 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion clippy_lints/src/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,17 @@ impl<'tcx> LateLintPass<'tcx> for DocMarkdown {
hir::ItemKind::Impl(ref impl_) => {
self.in_trait_impl = impl_.of_trait.is_some();
},
_ => {},
hir::ItemKind::Trait(_, unsafety, ..) => {
if !headers.safety && unsafety == hir::Unsafety::Unsafe {
span_lint(
cx,
MISSING_SAFETY_DOC,
item.span,
"docs for unsafe trait missing `# Safety` section",
);
}
},
_ => (),
}
}

Expand Down
1 change: 1 addition & 0 deletions tests/ui/def_id_nocore.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

#![feature(no_core, lang_items, start)]
#![no_core]
#![allow(clippy::missing_safety_doc)]

#[link(name = "c")]
extern "C" {}
Expand Down
2 changes: 1 addition & 1 deletion tests/ui/def_id_nocore.stderr
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
error: methods called `as_*` usually take `self` by reference or `self` by mutable reference
--> $DIR/def_id_nocore.rs:26:19
--> $DIR/def_id_nocore.rs:27:19
|
LL | pub fn as_ref(self) -> &'static str {
| ^^^^
Expand Down
21 changes: 19 additions & 2 deletions tests/ui/doc_unsafe.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,25 @@ mod private_mod {

pub use private_mod::republished;

pub trait UnsafeTrait {
pub trait SafeTraitUnsafeMethods {
unsafe fn woefully_underdocumented(self);

/// # Safety
unsafe fn at_least_somewhat_documented(self);
}

pub unsafe trait UnsafeTrait {
fn method();
}

/// # Safety
pub unsafe trait DocumentedUnsafeTrait {
fn method2();
}

pub struct Struct;

impl UnsafeTrait for Struct {
impl SafeTraitUnsafeMethods for Struct {
unsafe fn woefully_underdocumented(self) {
// all is well
}
Expand All @@ -53,6 +62,14 @@ impl UnsafeTrait for Struct {
}
}

unsafe impl UnsafeTrait for Struct {
fn method() {}
}

unsafe impl DocumentedUnsafeTrait for Struct {
fn method2() {}
}

impl Struct {
pub unsafe fn more_undocumented_unsafe() -> Self {
unimplemented!();
Expand Down
14 changes: 11 additions & 3 deletions tests/ui/doc_unsafe.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,24 @@ error: unsafe function's docs miss `# Safety` section
LL | unsafe fn woefully_underdocumented(self);
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: docs for unsafe trait missing `# Safety` section
--> $DIR/doc_unsafe.rs:44:1
|
LL | / pub unsafe trait UnsafeTrait {
LL | | fn method();
LL | | }
| |_^

error: unsafe function's docs miss `# Safety` section
--> $DIR/doc_unsafe.rs:57:5
--> $DIR/doc_unsafe.rs:74:5
|
LL | / pub unsafe fn more_undocumented_unsafe() -> Self {
LL | | unimplemented!();
LL | | }
| |_____^

error: unsafe function's docs miss `# Safety` section
--> $DIR/doc_unsafe.rs:73:9
--> $DIR/doc_unsafe.rs:90:9
|
LL | / pub unsafe fn whee() {
LL | | unimplemented!()
Expand All @@ -43,5 +51,5 @@ LL | very_unsafe!();
|
= note: this error originates in the macro `very_unsafe` (in Nightly builds, run with -Z macro-backtrace for more info)

error: aborting due to 5 previous errors
error: aborting due to 6 previous errors