Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul our documentation. #204

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Overhaul our documentation. #204

merged 1 commit into from
Jan 9, 2025

Conversation

Alexhuszagh
Copy link
Owner

@Alexhuszagh Alexhuszagh commented Jan 9, 2025

This also adds in a few API methods as well as deprecations.

Added

  • Options::buffer_size_const
  • build_checked and build_unchecked to our NumberFormatBuilder API
  • Added build_checked to our Options API.
  • Added has_digit_separator to NumberFormat.
  • Re-export NumberFormat to our other crates.

Changed

  • Lowered the MSRV from 1.63.0 to 1.61.0 and adds support for most testing on 1.60.0 (this is not guaranteed).
  • Reduced the required buffer size for integer and float writers when using buffer_size and buffer_size_const for decimal numbers.
  • Deprecated NumberFormatBuilder::build due to a lack of validation.
  • Deprecated Options::set_* in our write float API since options should be considered immutable.
  • Removed static_assertions dependency.

Fixed

  • Bug where the radix feature wasn't enabling power-of-two in lexical-core or lexical.

@Alexhuszagh Alexhuszagh added bug Something isn't working documentation Fix in the documentation labels Jan 9, 2025
@Alexhuszagh Alexhuszagh added this to the 1.1 milestone Jan 9, 2025
@Alexhuszagh Alexhuszagh self-assigned this Jan 9, 2025
@Alexhuszagh Alexhuszagh force-pushed the docsrs branch 4 times, most recently from a9677c3 to de42778 Compare January 9, 2025 02:41
This also adds in a few API methods as well as deprecations.

- `Options::buffer_size_const`
- `build_checked` and `build_unchecked` to our `NumberFormatBuilder` API
- Added `build_checked` to our `Options` API.
- Added `has_digit_separator` to `NumberFormat`.
- Re-export `NumberFormat` to our other crates.

- Lowered the MSRV from 1.63.0 to 1.61.0 and adds support for most testing on 1.60.0 (this is not guaranteed).
- Reduced the required buffer size for integer and float writers when using `buffer_size` and `buffer_size_const` for decimal numbers.
- Deprecated `NumberFormatBuilder::build` due to a lack of validation.
- Deprecated `Options::set_*` in our write float API since options should be considered immutable.
- Removed `static_assertions` dependency.

- Bug where the `radix` feature wasn't enabling `power-of-two` in `lexical-core` or `lexical`.
@Alexhuszagh Alexhuszagh merged commit 42babea into main Jan 9, 2025
38 checks passed
@Alexhuszagh Alexhuszagh deleted the docsrs branch January 9, 2025 03:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Fix in the documentation
Projects
None yet
1 participant