Update docs#15
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation clarity in both the core crate and the README by refining trait references and updating example error handling.
- Simplify and clarify Rustdoc comments in
quadtree.rs, switch fromok_or_eyre/unwraptoexpectin examples, and explicitly note where trait items come from. - Update README.md to use consistent backtick syntax for trait names and add a note that
PointimplementsStorableautomatically.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| quadtree/src/quadtree.rs | Refined doc comments, updated example to use expect, and clarified trait references. |
| README.md | Unified trait reference syntax, updated example error handling, and noted Point’s automatic trait implementation. |
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.
No description provided.