mirror of
https://github.com/rust-lang/rust.git
synced 2024-12-14 09:36:06 +00:00
add test for missing_panic_doc on assert_eq/assert_ne
This commit is contained in:
parent
2f81e4e34f
commit
8e5dd4b2e9
@ -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
|
||||
@ -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");
|
||||
|
@ -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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user