Improve docs (from GitHub Copilot’s suggestions)

Author: onethumb

src/crc32/fusion/x86/iscsi/avx512_pclmulqdq.rs

@@ -11,6 +11,8 @@
 /// ./generate -i avx512 -p crc32c -a v4s3x3
 ///
 /// Modified as necessary for this Rust implementation.
+///
+/// Uses AVX-512 instructions so only available after Rust 1.89 (when AVX-512 stabilized)
 #[rustversion::since(1.89)]
 #[inline]
 #[target_feature(enable = "avx512vl,pclmulqdq")]

src/crc32/fusion/x86/iscsi/avx512_vpclmulqdq.rs

@@ -11,6 +11,9 @@
 /// ./generate -i avx512_vpclmulqdq -p crc32c -a v3x2
 ///
 /// Modified as necessary for this Rust implementation.
+///
+/// Uses AVX-512 VPCLMULQDQ instructions, so only available after Rust 1.89 (when AVX-512
+/// stabilized)
 #[rustversion::since(1.89)]
 #[inline]
 #[target_feature(enable = "avx512vl,vpclmulqdq")]

src/crc32/fusion/x86/mod.rs

@@ -28,8 +28,7 @@ use std::arch::x86::*;
 #[cfg(target_arch = "x86_64")]
 use std::arch::x86_64::*;
 
-/// Safe wrapper for CRC32 iSCSI calculation using AVX-512
-/// CRC32 iSCSI calculation for Rust versions before 1.89
+/// CRC32 iSCSI calculation for Rust versions before 1.89 (pre-AVX-512 support)
 ///
 ///
 /// This function is called by the wrapper layer after feature detection has been performed.
@@ -42,7 +41,8 @@ pub fn crc32_iscsi(crc: u32, data: &[u8]) -> u32 {
     unsafe { crc32_iscsi_sse_v4s3x3(crc, data.as_ptr(), data.len()) }
 }
 
-/// CRC32 iSCSI calculation using the highest available instruction set
+/// CRC32 iSCSI calculation using the highest available instruction set after Rust 1.89
+/// (post-AVX-512 support)
 ///
 /// This function is called by the wrapper layer after feature detection has been performed.
 /// The wrapper layer ensures that only the appropriate implementation is called based on

src/feature_detection.rs

@@ -100,7 +100,7 @@ unsafe fn detect_arch_capabilities() -> ArchCapabilities {
 unsafe fn detect_aarch64_features() -> ArchCapabilities {
     use std::arch::is_aarch64_feature_detected;
 
-    // AES is available on essentially all Aarch64 CPUs and provides the PMULL instructions
+    // AES is available on essentially all AArch64 CPUs and provides the PMULL instructions
     let has_aes = is_aarch64_feature_detected!("aes");
 
     // SHA3 is available on modern Aarch64 CPUs, and provides the EOR3 instruction for efficient