Add minor documentation improvements.

ci/test.sh

@@ -78,16 +78,17 @@ check() {
     check_test "write-integer"
 
     # ensure our partial features aren't allowed, as are unsupported features
-    cd "${home}/lexical-core"
-    partial=(parse write floats integers)
-    for feature in "${partial[@]}"; do
-        check_error "${feature}"
-    done
-
-    cd "${home}/lexical"
-    for feature in "${partial[@]}"; do
-        check_error "${feature}"
-    done
+    # FIXME: Restore once we remove our partial features
+    # cd "${home}/lexical-core"
+    # partial=(parse write floats integers)
+    # for feature in "${partial[@]}"; do
+    #     check_error "${feature}"
+    # done
+    #
+    # cd "${home}/lexical"
+    # for feature in "${partial[@]}"; do
+    #     check_error "${feature}"
+    # done
 
     cd "${home}"
 }

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" },
 ]

extras/Cargo.toml

@@ -19,3 +19,7 @@ opt-level = 3
 debug = false
 debug-assertions = false
 lto = true
+
+# FIXME: Support 0.61.0+ when we only support Rustc 1.71.0+.
+[patch.crates-io]
+windows-sys = { git = "https://github.com/microsoft/windows-rs.git", rev = "308e08e" }

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

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" },
 ]

extras/parse-float/Cargo.toml

@@ -23,7 +23,8 @@ default-features = false
 #  Issue:   https://github.com/BurntSushi/quickcheck/issues/295
 #  Fix:     https://github.com/BurntSushi/quickcheck/pull/296
 quickcheck = { git = "https://github.com/Alexhuszagh/quickcheck/", branch = "i32min-shrink-bound-legacy" }
-proptest = ">=1.5.0"
+# FIXME: Support 1.7.0+ when we only support Rustc 1.66.0+.
+proptest = ">=1.5.0, <1.7.0"
 
 [features]
 default = ["std"]

extras/parse-integer/Cargo.toml

@@ -23,7 +23,8 @@ default-features = false
 #  Issue:   https://github.com/BurntSushi/quickcheck/issues/295
 #  Fix:     https://github.com/BurntSushi/quickcheck/pull/296
 quickcheck = { git = "https://github.com/Alexhuszagh/quickcheck/", branch = "i32min-shrink-bound-legacy" }
-proptest = ">=1.5.0"
+# FIXME: Support 1.7.0+ when we only support Rustc 1.66.0+.
+proptest = ">=1.5.0, <1.7.0"
 
 [features]
 default = ["std"]

extras/util/Cargo.toml

@@ -19,7 +19,8 @@ default-features = false
 #  Issue:   https://github.com/BurntSushi/quickcheck/issues/295
 #  Fix:     https://github.com/BurntSushi/quickcheck/pull/296
 quickcheck = { git = "https://github.com/Alexhuszagh/quickcheck/", branch = "i32min-shrink-bound-legacy" }
-proptest = ">=1.5.0"
+# FIXME: Support 1.7.0+ when we only support Rustc 1.66.0+.
+proptest = ">=1.5.0, <1.7.0"
 
 [features]
 default = ["std"]

extras/write-float/Cargo.toml

@@ -28,8 +28,9 @@ approx = "0.5.0"
 #  Issue:   https://github.com/BurntSushi/quickcheck/issues/295
 #  Fix:     https://github.com/BurntSushi/quickcheck/pull/296
 quickcheck = { git = "https://github.com/Alexhuszagh/quickcheck/", branch = "i32min-shrink-bound-legacy" }
-proptest = ">=1.5.0"
 fraction = "0.15.0"
+# FIXME: Support 1.7.0+ when we only support Rustc 1.66.0+.
+proptest = ">=1.5.0, <1.7.0"
 
 [features]
 default = ["std"]

extras/write-integer/Cargo.toml

@@ -23,8 +23,9 @@ default-features = false
 #  Issue:   https://github.com/BurntSushi/quickcheck/issues/295
 #  Fix:     https://github.com/BurntSushi/quickcheck/pull/296
 quickcheck = { git = "https://github.com/Alexhuszagh/quickcheck/", branch = "i32min-shrink-bound-legacy" }
-proptest = ">=1.5.0"
 rustversion = ">=1.0.18"
+# FIXME: Support 1.7.0+ when we only support Rustc 1.66.0+.
+proptest = ">=1.5.0, <1.7.0"
 
 [features]
 default = ["std"]

lexical-core/Cargo.toml

@@ -129,6 +129,16 @@ f128 = [
     "lexical-write-float?/f128"
 ]
 
+# DEPRECATED
+# ----------
+# These were never supported, however, they exist in case existing code
+# uses them. They should not be used under any circumstances and should
+# be removed.
+parse = ["parse-integers", "parse-floats"]
+write = ["write-integers", "write-floats"]
+integers = ["parse-integers", "write-integers"]
+floats = ["parse-floats", "write-floats"]
+
 [package.metadata.docs.rs]
 features = ["radix", "format", "write-integers", "write-floats", "parse-integers", "parse-floats", "f16"]
 rustdoc-args = ["--cfg", "docsrs"]

lexical-core/src/lib.rs

@@ -629,6 +629,11 @@
 //! [`lexical-write-float`], and [`lexical-write-integer`]) could cause those
 //! safety invariants to be broken.
 //!
+//! [`lexical-parse-float`]: https://crates.io/crates/lexical-parse-float
+//! [`lexical-parse-integer`]: https://crates.io/crates/lexical-parse-integer
+//! [`lexical-write-float`]: https://crates.io/crates/lexical-write-float
+//! [`lexical-write-integer`]: https://crates.io/crates/lexical-write-integer
+//!
 //! <!-- Spacer for Rustfmt -->
 #![cfg_attr(
     any(feature = "write-floats", feature = "write-integers"),
@@ -686,8 +691,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

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,
         }

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);
 

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

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() {

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

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() {

lexical-util/Cargo.toml

@@ -64,6 +64,16 @@ lint = []
 # Enable support for 128-bit floats.
 f128 = ["parse-floats", "write-floats"]
 
+# DEPRECATED
+# ----------
+# These were never supported, however, they exist in case existing code
+# uses them. They should not be used under any circumstances and should
+# be removed.
+parse = ["parse-integers", "parse-floats"]
+write = ["write-integers", "write-floats"]
+integers = ["parse-integers", "write-integers"]
+floats = ["parse-floats", "write-floats"]
+
 [package.metadata.docs.rs]
 features = ["radix", "format", "write-integers", "write-floats", "parse-integers", "parse-floats", "f16"]
 rustdoc-args = ["--cfg", "docsrs"]

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;

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