Skip to content

Commit

Permalink
add test for missing_panic_doc on assert_eq/assert_ne
Browse files Browse the repository at this point in the history
  • Loading branch information
ABouttefeux committed Apr 5, 2021
1 parent 2f81e4e commit 8e5dd4b
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 1 deletion.
32 changes: 32 additions & 0 deletions tests/ui/missing_panics_doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ pub fn unreachable_and_panic() {
if true { unreachable!() } else { panic!() }
}

/// This needs to be documented
pub fn assert_eq() {
let x = 0;
assert_eq!(x, 0);
}

/// This needs to be documented
pub fn assert_ne() {
let x = 0;
assert_ne!(x, 0);
}

/// This is documented
///
/// # Panics
Expand Down Expand Up @@ -83,6 +95,26 @@ pub fn unreachable_amd_panic_documented() {
if true { unreachable!() } else { panic!() }
}

/// This is documented
///
/// # Panics
///
/// Panics if `x` is not 0.
pub fn assert_eq_documented() {
let x = 0;
assert_eq!(x, 0);
}

/// This is documented
///
/// # Panics
///
/// Panics if `x` is 0.
pub fn assert_ne_documented() {
let x = 0;
assert_ne!(x, 0);
}

/// This is okay because it is private
fn unwrap_private() {
let result = Err("Hi");
Expand Down
34 changes: 33 additions & 1 deletion tests/ui/missing_panics_doc.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -78,5 +78,37 @@ LL | if true { unreachable!() } else { panic!() }
| ^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)

error: aborting due to 5 previous errors
error: docs for function which may panic missing `# Panics` section
--> $DIR/missing_panics_doc.rs:37:1
|
LL | / pub fn assert_eq() {
LL | | let x = 0;
LL | | assert_eq!(x, 0);
LL | | }
| |_^
|
note: first possible panic found here
--> $DIR/missing_panics_doc.rs:39:5
|
LL | assert_eq!(x, 0);
| ^^^^^^^^^^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)

error: docs for function which may panic missing `# Panics` section
--> $DIR/missing_panics_doc.rs:43:1
|
LL | / pub fn assert_ne() {
LL | | let x = 0;
LL | | assert_ne!(x, 0);
LL | | }
| |_^
|
note: first possible panic found here
--> $DIR/missing_panics_doc.rs:45:5
|
LL | assert_ne!(x, 0);
| ^^^^^^^^^^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)

error: aborting due to 7 previous errors

0 comments on commit 8e5dd4b

Please sign in to comment.