Skip to content

docs: polish README wording and fix inaccurate comments#44

Merged
jiegec merged 1 commit intorcore-os:masterfrom
mevinagrise:docs-wording-fixes
Mar 26, 2026
Merged

docs: polish README wording and fix inaccurate comments#44
jiegec merged 1 commit intorcore-os:masterfrom
mevinagrise:docs-wording-fixes

Conversation

@mevinagrise
Copy link
Copy Markdown
Contributor

This PR improves a few small wording and accuracy issues in the documentation and comments.

Specific changes include:

  • Changed To init the allocator: to To initialize the allocator: in README.md.
  • Corrected the wording in the license acknowledgement and fixed the phil-opp spelling.
  • Updated the doc comment on LockedFrameAllocator::new to say Creates an empty frame allocator. instead of Creates an empty heap.

Why this is useful:

  • It improves documentation clarity without changing behavior.
  • It fixes a misleading comment in the FrameAllocator API.
  • It keeps the PR tightly scoped and easy to review.

Testing:

  • Ran cargo test.
  • Ran cargo test --doc.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR polishes documentation and inline Rust doc comments to improve clarity and correctness without changing runtime behavior.

Changes:

  • Updated LockedFrameAllocator::new doc 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-opp spelling.

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.

@jiegec jiegec merged commit 05edc00 into rcore-os:master Mar 26, 2026
6 checks passed
@mevinagrise mevinagrise deleted the docs-wording-fixes branch March 30, 2026 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants