Fix clippy lints and minor documentation enhancements.

Alexhuszagh · Alexhuszagh · commit be25b410b5fe · 2025-09-20T20:57:59.000-05:00
diff --git a/clippy.toml b/clippy.toml
@@ -4,7 +4,7 @@ disallowed-macros = [
     { path = "std::print", reason = "no IO allowed" },
     { path = "std::println", reason = "no IO allowed" },
     { path = "std::format", reason = "no string allocation allowed" },
-    { path = "std::debug", reason = "debugging macros should not be present in any release" },
+    { path = "std::dbg", reason = "debugging macros should not be present in any release" },
     # NOTE: unimplemented is fine because this can be for intentionally disabled methods
     { path = "std::todo", reason = "should never have TODO macros in releases" },
 ]
@@ -14,7 +14,7 @@ disallowed-methods = [
     { path = "std::io::stderr", reason = "no IO allowed" },
 ]
 disallowed-types = [
-    { path = "std::io::File", reason = "no IO allowed" },
+    { path = "std::fs::File", reason = "no IO allowed" },
     { path = "std::io::BufReader", reason = "need our own abstractions for reading/writing" },
     { path = "std::io::BufWriter", reason = "need our own abstractions for reading/writing" },
 ]
diff --git a/extras/benchmark/write-float/special.rs b/extras/benchmark/write-float/special.rs
@@ -19,7 +19,14 @@ macro_rules! gen_vec {
             let value = fastrand::$i($exp_mask..);
             // NOTE: We want mem::transmute, not from_bits because we
             // don't want the special handling of from_bits
-            #[allow(clippy::transmute_int_to_float)]
+            // FIXME: Move to `to_bits` in 1.83.0+ (const stable)
+            // FIXME: change to `unnecessary_transmutes` when supported.
+            #[allow(
+                renamed_and_removed_lints,
+                unknown_lints,
+                clippy::transmute_int_to_float,
+                unnecessary_transmutes
+            )]
             vec.push(unsafe { mem::transmute::<$i, $f>(value) });
         }
         vec
diff --git a/extras/clippy.toml b/extras/clippy.toml
@@ -4,7 +4,7 @@ disallowed-macros = [
     { path = "std::print", reason = "no IO allowed" },
     { path = "std::println", reason = "no IO allowed" },
     { path = "std::format", reason = "no string allocation allowed" },
-    { path = "std::debug", reason = "debugging macros should not be present in any release" },
+    { path = "std::dbg", reason = "debugging macros should not be present in any release" },
     # NOTE: unimplemented is fine because this can be for intentionally disabled methods
     { path = "std::todo", reason = "should never have TODO macros in releases" },
 ]
@@ -14,7 +14,7 @@ disallowed-methods = [
     { path = "std::io::stderr", reason = "no IO allowed" },
 ]
 disallowed-types = [
-    { path = "std::io::File", reason = "no IO allowed" },
+    { path = "std::fs::File", reason = "no IO allowed" },
     { path = "std::io::BufReader", reason = "need our own abstractions for reading/writing" },
     { path = "std::io::BufWriter", reason = "need our own abstractions for reading/writing" },
 ]
diff --git a/lexical-core/src/lib.rs b/lexical-core/src/lib.rs
@@ -686,8 +686,7 @@
     clippy::unnecessary_safety_comment,
     clippy::semicolon_if_nothing_returned,
     clippy::unwrap_used,
-    clippy::as_underscore,
-    clippy::doc_markdown
+    clippy::as_underscore
 )]
 #![allow(
     // used when concepts are logically separate
diff --git a/lexical-parse-float/src/bigint.rs b/lexical-parse-float/src/bigint.rs
@@ -635,7 +635,7 @@ impl<const SIZE: usize> StackVec<SIZE> {
     /// Create a reverse view of the vector for indexing.
     #[must_use]
     #[inline(always)]
-    pub fn rview(&self) -> ReverseView<Limb> {
+    pub fn rview(&self) -> ReverseView<'_, Limb> {
         ReverseView {
             inner: self,
         }
diff --git a/lexical-parse-float/src/float.rs b/lexical-parse-float/src/float.rs
@@ -64,7 +64,6 @@ pub trait RawFloat: Float + ExactFloat + MaxDigits {
     #[must_use]
     #[inline(always)]
     fn int_pow_fast_path(exponent: usize, radix: u32) -> u64 {
-        // SAFETY: safe as long as the exponent is smaller than the radix table.
         #[cfg(not(feature = "compact"))]
         return get_small_int_power(exponent, radix);
 
@@ -76,7 +75,6 @@ pub trait RawFloat: Float + ExactFloat + MaxDigits {
 impl RawFloat for f32 {
     #[inline(always)]
     fn pow_fast_path(exponent: usize, radix: u32) -> Self {
-        // SAFETY: safe as long as the exponent is smaller than the radix table.
         #[cfg(not(feature = "compact"))]
         return get_small_f32_power(exponent, radix);
 
@@ -88,7 +86,6 @@ impl RawFloat for f32 {
 impl RawFloat for f64 {
     #[inline(always)]
     fn pow_fast_path(exponent: usize, radix: u32) -> Self {
-        // SAFETY: safe as long as the exponent is smaller than the radix table.
         #[cfg(not(feature = "compact"))]
         return get_small_f64_power(exponent, radix);
 
diff --git a/lexical-parse-float/src/lib.rs b/lexical-parse-float/src/lib.rs
@@ -518,8 +518,7 @@
     clippy::unnecessary_safety_comment,
     clippy::semicolon_if_nothing_returned,
     clippy::unwrap_used,
-    clippy::as_underscore,
-    clippy::doc_markdown
+    clippy::as_underscore
 )]
 #![allow(
     // used when concepts are logically separate
diff --git a/lexical-parse-float/src/options.rs b/lexical-parse-float/src/options.rs
@@ -653,7 +653,8 @@ impl OptionsBuilder {
     ///
     /// # Panics
     ///
-    /// If the built options are not valid.
+    /// If the built options are not valid. This should always
+    /// be used within a const context to avoid panics at runtime.
     #[inline(always)]
     pub const fn build_strict(&self) -> Options {
         match self.build() {
diff --git a/lexical-parse-integer/src/lib.rs b/lexical-parse-integer/src/lib.rs
@@ -263,8 +263,7 @@
     clippy::unnecessary_safety_comment,
     clippy::semicolon_if_nothing_returned,
     clippy::unwrap_used,
-    clippy::as_underscore,
-    clippy::doc_markdown
+    clippy::as_underscore
 )]
 #![allow(
     // used when concepts are logically separate
diff --git a/lexical-parse-integer/src/options.rs b/lexical-parse-integer/src/options.rs
@@ -131,7 +131,15 @@ impl OptionsBuilder {
         }
     }
 
-    /// Build the [`Options`] struct. This can never panic.
+    /// Build the [`Options`] struct.
+    ///
+    /// This can never panic.
+    ///
+    /// <!-- # Panics
+    ///
+    /// If the built options are not valid. This should always
+    /// be used within a const context to avoid panics at runtime.
+    /// -->
     #[inline(always)]
     pub const fn build_strict(&self) -> Options {
         match self.build() {
diff --git a/lexical-util/src/format_builder.rs b/lexical-util/src/format_builder.rs
@@ -3277,7 +3277,8 @@ impl NumberFormatBuilder {
     ///
     /// # Panics
     ///
-    /// If the built format is not valid.
+    /// If the built format is not valid. This should always
+    /// be used within a const context to avoid panics at runtime.
     #[inline(always)]
     pub const fn build_strict(&self) -> u128 {
         use crate::format::format_error_impl;
diff --git a/lexical-util/src/lib.rs b/lexical-util/src/lib.rs
@@ -86,8 +86,7 @@
     clippy::unnecessary_safety_comment,
     clippy::semicolon_if_nothing_returned,
     clippy::unwrap_used,
-    clippy::as_underscore,
-    clippy::doc_markdown
+    clippy::as_underscore
 )]
 #![allow(
     // used when concepts are logically separate
diff --git a/lexical-util/src/options.rs b/lexical-util/src/options.rs
diff --git a/lexical-write-float/src/lib.rs b/lexical-write-float/src/lib.rs
diff --git a/lexical-write-float/src/options.rs b/lexical-write-float/src/options.rs
diff --git a/lexical-write-integer/src/lib.rs b/lexical-write-integer/src/lib.rs
diff --git a/lexical-write-integer/src/options.rs b/lexical-write-integer/src/options.rs
diff --git a/lexical/src/lib.rs b/lexical/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ disallowed-macros = [`
`4`	`4`	`{ path = "std::print", reason = "no IO allowed" },`
`5`	`5`	`{ path = "std::println", reason = "no IO allowed" },`
`6`	`6`	`{ path = "std::format", reason = "no string allocation allowed" },`
`7`		`- { path = "std::debug", reason = "debugging macros should not be present in any release" },`
	`7`	`+ { path = "std::dbg", reason = "debugging macros should not be present in any release" },`
`8`	`8`	`# NOTE: unimplemented is fine because this can be for intentionally disabled methods`
`9`	`9`	`{ path = "std::todo", reason = "should never have TODO macros in releases" },`
`10`	`10`	`]`
`@@ -14,7 +14,7 @@ disallowed-methods = [`
`14`	`14`	`{ path = "std::io::stderr", reason = "no IO allowed" },`
`15`	`15`	`]`
`16`	`16`	`disallowed-types = [`
`17`		`- { path = "std::io::File", reason = "no IO allowed" },`
	`17`	`+ { path = "std::fs::File", reason = "no IO allowed" },`
`18`	`18`	`{ path = "std::io::BufReader", reason = "need our own abstractions for reading/writing" },`
`19`	`19`	`{ path = "std::io::BufWriter", reason = "need our own abstractions for reading/writing" },`
`20`	`20`	`]`
Original file line number	Diff line number	Diff line change
`@@ -635,7 +635,7 @@ impl<const SIZE: usize> StackVec<SIZE> {`
`635`	`635`	`/// Create a reverse view of the vector for indexing.`
`636`	`636`	`#[must_use]`
`637`	`637`	`#[inline(always)]`
`638`		`- pub fn rview(&self) -> ReverseView<Limb> {`
	`638`	`+ pub fn rview(&self) -> ReverseView<'_, Limb> {`
`639`	`639`	`ReverseView {`
`640`	`640`	`inner: self,`
`641`	`641`	`}`