crypto-bigint: add target-specific rustdocs (#500)

RustCrypto · Jun 22, 2021 · 6abedc8 · 6abedc8
1 parent b527f61
commit 6abedc8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/crypto-bigint/src/limb/from.rs b/crypto-bigint/src/limb/from.rs
@@ -1,29 +1,30 @@
-//! Limb from conversions
+//! `From`-like conversions for [`Limb`].
 
 use super::{Inner, Limb, Wide};
 
 impl Limb {
-    /// Create a [`Limb`] from a `u8` (const-friendly)
+    /// Create a [`Limb`] from a `u8` integer (const-friendly)
     // TODO(tarcieri): replace with `const impl From<u8>` when stable
     pub const fn from_u8(n: u8) -> Self {
         Limb(n as Inner)
     }
 
-    /// Create a [`Limb`] from a `u16` (const-friendly)
+    /// Create a [`Limb`] from a `u16` integer (const-friendly)
     // TODO(tarcieri): replace with `const impl From<u16>` when stable
     pub const fn from_u16(n: u16) -> Self {
         Limb(n as Inner)
     }
 
-    /// Create a [`Limb`] from a `u32` (const-friendly)
+    /// Create a [`Limb`] from a `u32` integer (const-friendly)
     // TODO(tarcieri): replace with `const impl From<u32>` when stable
     pub const fn from_u32(n: u32) -> Self {
         Limb(n as Inner)
     }
 
-    /// Create a [`Limb`] from a `u64` (const-friendly)
+    /// Create a [`Limb`] from a `u64` integer (const-friendly)
     // TODO(tarcieri): replace with `const impl From<u64>` when stable
     #[cfg(target_pointer_width = "64")]
+    #[cfg_attr(docsrs, doc(cfg(target_pointer_width = "64")))]
     pub const fn from_u64(n: u64) -> Self {
         Limb(n)
     }
@@ -51,6 +52,7 @@ impl From<u32> for Limb {
 }
 
 #[cfg(target_pointer_width = "64")]
+#[cfg_attr(docsrs, doc(cfg(target_pointer_width = "64")))]
 impl From<u64> for Limb {
     #[inline]
     fn from(n: u64) -> Limb {

diff --git a/crypto-bigint/src/uint/from.rs b/crypto-bigint/src/uint/from.rs
@@ -121,13 +121,15 @@ impl<const LIMBS: usize> From<u128> for UInt<LIMBS> {
 }
 
 #[cfg(target_pointer_width = "32")]
+#[cfg_attr(docsrs, doc(cfg(target_pointer_width = "32")))]
 impl From<U64> for u64 {
     fn from(n: U64) -> u64 {
         (n.limbs[0].0 as u64) | ((n.limbs[1].0 as u64) << 32)
     }
 }
 
 #[cfg(target_pointer_width = "64")]
+#[cfg_attr(docsrs, doc(cfg(target_pointer_width = "64")))]
 impl From<U64> for u64 {
     fn from(n: U64) -> u64 {
         n.limbs[0].into()