Fix spelling in std::pin documentation #80191
Closed
Conversation
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
Signed-off-by: Aaron Erhardt <[email protected]>
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @shepmaster (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
"pointee" is correct. It describes the pointed-at object. |
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.
Recently I read the documentation of std::pin and found that it contains several spelling mistakes where pointer is misspelled "pointee". Actually, it might as well be correct for some reason because I've found that "pointee" appears in quite a few files of the Rust source code and has some use in LLVM (I wonder who had this incredibly bad idea to let a data type look like a spelling mistake). Also if it's correct this term comes out of nowhere and is never explained anywhere - at least as far I know. Not even searching the internet can tell me what a "pointee" should be.
I did hesitate a bit because if this was a mistake it should have been already fixed a long time ago but despite my research I couldn't find a single reason why "pointee" would be correct - at least inside the std::pin documentation.
TL;DR this PR replaces "pointee" with "pointer" in the doc for std::pin which might or might not be correct