Merge rust-bitcoin/rust-bitcoin#4471: Change rustdoc tag from `compile_fail` to `ignore`
f5b716b099
Change rustdoc tag from compile_fail to ignore (Jamil Lambert, PhD)
Pull request description:
The example code is supposed to fail to compile, but if it does run it panics. This somehow confuses the compiler so that either the `compile_fail` tag compiles but causes a lint warning about the panic or using `should_panic` fails to compile.
Change the tag to `ignore`
Closes #4259
ACKs for top commit:
apoelstra:
ACK f5b716b09952957dd1b57181fdfa98173e7b5981; successfully ran local tests
Tree-SHA512: 41d14d45f12f989f5875490311a135372325a3bd626cfcea0767de32c14873348c639d14c4774219fca60de712772bb1922ad1b572435f4b5b1e318e1049620c
This commit is contained in:
commit
dc499b07e5
|
@ -9,10 +9,10 @@ pub trait SliceExt {
|
|||
///
|
||||
/// Note that `N` must not be zero:
|
||||
///
|
||||
/// ```compile_fail
|
||||
/// ```ignore
|
||||
/// # use bitcoin_internals::slice::SliceExt;
|
||||
/// let slice = [1, 2, 3];
|
||||
/// let _fail = slice.bitcoin_as_chunks::<0>();
|
||||
/// let _fail = slice.bitcoin_as_chunks::<0>(); // Fails to compile
|
||||
/// ```
|
||||
fn bitcoin_as_chunks<const N: usize>(&self) -> (&[[Self::Item; N]], &[Self::Item]);
|
||||
|
||||
|
@ -20,10 +20,10 @@ pub trait SliceExt {
|
|||
///
|
||||
/// Note that `N` must not be zero:
|
||||
///
|
||||
/// ```compile_fail
|
||||
/// ```ignore
|
||||
/// # use bitcoin_internals::slice::SliceExt;
|
||||
/// let mut slice = [1, 2, 3];
|
||||
/// let _fail = slice.bitcoin_as_chunks_mut::<0>();
|
||||
/// let _fail = slice.bitcoin_as_chunks_mut::<0>(); // Fails to compile
|
||||
/// ```
|
||||
fn bitcoin_as_chunks_mut<const N: usize>(
|
||||
&mut self,
|
||||
|
|
Loading…
Reference in New Issue