improve docs

Author: robamu

cortex-m/src/peripheral/nvic.rs

@@ -144,10 +144,10 @@ impl NVIC {
     /// Returns the NVIC priority of `interrupt`
     ///
     /// *NOTE* The NVIC encodes priorities in the *most-significant* bits of the 8-bit block for
-    /// each interrupt. This means that the priority value passed to this function MUST be shifted
-    /// by (8 - NUMBER_OF_PRIORITY_BITS), where NUMBER_OF_PRIORITY_BITS can be different between
-    /// cores. Also for NVIC priorities, a lower value (e.g. `0b0000_0000`) has higher
-    /// priority (urgency) than a larger value (e.g. `0b0010_0000`).
+    /// each interrupt. This means that the priority value retrieved by this function MUST be
+    /// right-shifted by (8 - NUMBER_OF_PRIORITY_BITS), where NUMBER_OF_PRIORITY_BITS can be
+    /// different between cores. Also for NVIC priorities, a lower value (e.g. `0b0000_0000`) has
+    /// higher priority (urgency) than a larger value (e.g. `0b0100_0000`).
     #[inline]
     pub fn get_priority<I>(interrupt: I) -> u8
     where