From 2bfde1dee3cd5cb9aa9a1bd5a50e2f5b71909669 Mon Sep 17 00:00:00 2001 From: Paul Crowley Date: Thu, 21 Mar 2024 06:31:25 -0700 Subject: [PATCH] Fix formatting error in shift_right Rustdoc doesn't correctly handle a backquoted literal that crosses a line break, so give it a line to itself. --- src/slice.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/slice.rs b/src/slice.rs index f73efc49..e71ef0c3 100644 --- a/src/slice.rs +++ b/src/slice.rs @@ -1504,8 +1504,9 @@ where /// Shifts the contents of a bit-slice “right” (away from the zero-index), /// clearing the “left” bits to `0`. /// - /// This is a strictly-worse analogue to taking `bits = &bits[.. bits.len() - /// - by]`: it must modify the entire memory region that `bits` governs, and + /// This is a strictly-worse analogue to taking + /// `bits = &bits[.. bits.len() - by]`: + /// it must modify the entire memory region that `bits` governs, and /// destroys contained information. Unless the actual memory layout and /// contents of your bit-slice matters to your program, you should /// *probably* prefer to munch your way backward through a bit-slice handle.