Add more comprehensive crate level docs for bevy_ptr #12391
Merged
Conversation
This file contains 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
james7132
added
C-Docs
alice-i-cecile
approved these changes
Mar 9, 2024
BD103
suggested changes
Mar 10, 2024
crates/bevy_ptr/README.md
Outdated
| @@ -6,8 +6,104 @@ | |||
| [](https://docs.rs/bevy_ptr/latest/bevy_ptr/) | |||
| [](https://discord.gg/bevy) | |||
|
|
|||
| The `bevy_ptr` crate provides low-level abstractions for working with pointers in a more safe way than using rust's raw pointers. | |||
| Pointers in computer programming, according to Wikipedia, are "objects in many programming languages that stores a memory address". | |||
There was a problem hiding this comment.
Suggested change
| Pointers in computer programming, according to Wikipedia, are "objects in many programming languages that stores a memory address". | |
| A pointer, according to Wikipedia, is an "object in many programming languages that stores a memory address". |
This fixes the plurality grammatical error where "stores" should be singular.
I would recommend rewriting this phrase, though. I don't think quoting Wikipedia is necessary here, especially with the "in many programming languages" part. It's implied that this is programming related, so the phrase is redundant.
There was a problem hiding this comment.
Agreed. Reworded this section.
crates/bevy_ptr/README.md
Outdated
| with them safer. | ||
|
|
||
| `bevy_ptr` is a crate that attempts to bridge the gap between the full blown unsafety of `*mut ()` and the safe `&'a T`, allowing users | ||
| to build progressively to choose what invariants to uphold. |
There was a problem hiding this comment.
Suggested change
| to build progressively to choose what invariants to uphold. | |
| to choose which invariants to uphold. |
There was a problem hiding this comment.
Reworded this ti be a bit clear what I meant here.
Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>
james7132
added
the
S-Ready-For-Final-Review
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.
Objective
Fixes #12301. Provide more comprehensive crate level docs for bevy_ptr, explaining it's methodology and design.
Solution
Write out said docs.