Skip to content

Move unnecessary_unsafety_doc to pedantic #9989

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

Merged
merged 1 commit into from
Nov 30, 2022
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
2 changes: 1 addition & 1 deletion clippy_lints/src/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ declare_clippy_lint! {
/// ```
#[clippy::version = "1.66.0"]
pub UNNECESSARY_SAFETY_DOC,
style,
restriction,
"`pub fn` or `pub trait` with `# Safety` docs"
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// aux-build:doc_unsafe_macros.rs

#![allow(clippy::let_unit_value)]
#![warn(clippy::unnecessary_safety_doc)]

#[macro_use]
extern crate doc_unsafe_macros;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
error: safe function's docs have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:18:1
--> $DIR/unnecessary_unsafety_doc.rs:19:1
|
LL | pub fn apocalypse(universe: &mut ()) {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: `-D clippy::unnecessary-safety-doc` implied by `-D warnings`

error: safe function's docs have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:44:5
--> $DIR/unnecessary_unsafety_doc.rs:45:5
|
LL | pub fn republished() {
| ^^^^^^^^^^^^^^^^^^^^

error: safe function's docs have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:57:5
--> $DIR/unnecessary_unsafety_doc.rs:58:5
|
LL | fn documented(self);
| ^^^^^^^^^^^^^^^^^^^^

error: docs for safe trait have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:67:1
--> $DIR/unnecessary_unsafety_doc.rs:68:1
|
LL | pub trait DocumentedSafeTrait {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: safe function's docs have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:95:5
--> $DIR/unnecessary_unsafety_doc.rs:96:5
|
LL | pub fn documented() -> Self {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: safe function's docs have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:122:9
--> $DIR/unnecessary_unsafety_doc.rs:123:9
|
LL | pub fn drive() {
| ^^^^^^^^^^^^^^
Expand All @@ -42,7 +42,7 @@ LL | very_safe!();
= note: this error originates in the macro `very_safe` (in Nightly builds, run with -Z macro-backtrace for more info)

error: docs for safe trait have unnecessary `# Safety` section
--> $DIR/doc_unnecessary_unsafe.rs:146:1
--> $DIR/unnecessary_unsafety_doc.rs:147:1
|
LL | pub trait DocumentedSafeTraitWithImplementationHeader {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down