Improve docs for mem::forget() #27521
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
|
r? @brson (rust_highfive has picked a reviewer for you, use r? to override) |
|
The PR says mem::swap but this seems to be a mem::forget change? |
|
lol i am the worst |
steveklabnik
changed the title
steveklabnik
force-pushed
the
doc_std_mem_forget
branch
from
a1297da to
d13be68
Compare
| @@ -84,7 +86,7 @@ pub use intrinsics::transmute; | |||
| /// mem::forget(file); | |||
| /// ``` | |||
| /// | |||
| /// The swap function uses forget to good effect. | |||
| /// The `mem::swap()` function uses forget to good effect: | |||
There was a problem hiding this comment.
It seems to be weird to include parens here, especially since it actually takes args.
There was a problem hiding this comment.
I've tended to always use parens when talking about a function(). I guess that's not official style...
There was a problem hiding this comment.
Yeah I generally don't...? In this case it's clear it's a function anyway.
There was a problem hiding this comment.
you wrapped mem::swap inside the ``, but not mem::forget?
|
r=me with nit |
steveklabnik
force-pushed
the
doc_std_mem_forget
branch
2 times, most recently
from
2fd7110 to
5af1b3f
Compare
|
@bors: r=gankro rollup |
|
📌 Commit 5af1b3f has been approved by |
We were burying the reason to use this function below a bunch of caveats about its usage. That's backwards. Why a function should be used belongs at the top of the docs, not the bottom. Also, add some extra links to related functions mentioned in the body.
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Aug 5, 2015
…gankro We were burying the reason to use this function below a bunch of caveats about its usage. That's backwards. Why a function should be used belongs at the top of the docs, not the bottom. Also, add some extra links to related functions mentioned in the body. /cc @abhijeetbhagat who pointed this out on IRC
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.
We were burying the reason to use this function below a bunch of caveats about
its usage. That's backwards. Why a function should be used belongs at the top of
the docs, not the bottom.
Also, add some extra links to related functions mentioned in the body.
/cc @abhijeetbhagat who pointed this out on IRC