Try to improve PhantomData docs with more examples #24059
Merged
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
| /// | ||
| /// Adding a field of type `PhantomData<T>` also indicates that your | ||
| /// struct owns data of type `T` and hence may drop one or more | ||
| /// instances of the type `T` could be dropped when instances of the |
There was a problem hiding this comment.
"may drop" and "could be dropped" are redundant here.
|
👍 |
| /// intent is not expressed in the code, since there are no uses of | ||
| /// the lifetime `'a` and hence it is not clear what data it applies | ||
| /// to. We can correct this by telling the compiler to act *as if* the | ||
| /// `Slice` struct contained a borrowed reference `&'a T`: |
There was a problem hiding this comment.
Using *mut T and then acting as if it were a &T (the mut vs. not, specifically) is mildly disconcerting.
|
r=me with @apasel422's grammar note, and my |
nikomatsakis
force-pushed
the
issue-22914-phantomdata-docs
branch
from
2d708b0 to
d166772
Compare
|
📌 Commit d166772 has been approved by |
|
(Incorporated feedback.) |
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Apr 7, 2015
…a-docs, r=huon This probably needs a bit more work, but I wanted to try and capture some common use cases and be a bit more helpful. r? @huonw cc @steveklabnik
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Apr 7, 2015
|
needs ae64d8e |
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 probably needs a bit more work, but I wanted to try and capture some common use cases and be a bit more helpful.
r? @huonw
cc @steveklabnik