Add more comprehensive crate level docs for bevy_ptr#12391
Add more comprehensive crate level docs for bevy_ptr#12391alice-i-cecile merged 11 commits intobevyengine:mainfrom
Conversation
james7132
added
C-Docs
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
Really awesome stuff: this is exactly the sort of writeup I was hoping for when I spun out that issue.
BD103
left a comment
BD103
left a comment
There was a problem hiding this comment.
This is some great documentation, but I have a few clarity and grammatical suggestions.
crates/bevy_ptr/README.md
Outdated
| [](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.
| 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.
| 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 <[email protected]>
james7132
added
the
S-Ready-For-Final-Review
3 participants
Objective
Fixes #12301. Provide more comprehensive crate level docs for bevy_ptr, explaining it's methodology and design.
Solution
Write out said docs.