docs: polish README wording and fix inaccurate comments#44
Merged
jiegec merged 1 commit intorcore-os:masterfrom Mar 26, 2026
Merged
docs: polish README wording and fix inaccurate comments#44jiegec merged 1 commit intorcore-os:masterfrom
jiegec merged 1 commit intorcore-os:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR polishes documentation and inline Rust doc comments to improve clarity and correctness without changing runtime behavior.
Changes:
- Updated
LockedFrameAllocator::newdoc comment to correctly describe creating an empty frame allocator. - Improved README wording for allocator initialization instructions.
- Refined README license acknowledgement wording and corrected the
phil-oppspelling.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/frame.rs |
Fixes an inaccurate doc comment for LockedFrameAllocator::new. |
README.md |
Clarifies initialization wording and improves license acknowledgement text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 improves a few small wording and accuracy issues in the documentation and comments.
Specific changes include:
To init the allocator:toTo initialize the allocator:inREADME.md.phil-oppspelling.LockedFrameAllocator::newto sayCreates an empty frame allocator.instead ofCreates an empty heap.Why this is useful:
FrameAllocatorAPI.Testing:
cargo test.cargo test --doc.