Documentation rewrite - #69
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR rewrites and expands the crate’s Rustdoc to better explain the conversion trait families, rounding modes, and the library’s “fallback behaviour” when using non-try_ conversion methods.
Changes:
- Reworked crate-level docs in
src/lib.rswith a quick-start example, rounding-mode overview, and clarified error semantics. - Expanded trait documentation in
src/traits.rs, adding richer guidance and examples for implementing conversions. - Improved rounding-mode documentation in
src/rounding.rs, including a shared definition of approximation limits and additional cross-links.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/traits.rs | Substantial Rustdoc updates for conversion traits, including new examples and implementation guidance. |
| src/rounding.rs | Enhanced rounding-mode docs and added a detailed “Limits of approximation” section reused by multiple modes. |
| src/lib.rs | Rewritten crate-level documentation with updated structure, examples, and clearer error/fallback explanations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
Surprisingly useful feedback: this found some errors on my part. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is a re-write or at least review of all existing documentation.