Various tutorial fixes. #10880
Merged
Various tutorial fixes. #10880
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
|
|
||
| # Creating Documentation | ||
|
|
||
| Documenting Rust APIs is quite simple To document a given item, we have "doc |
|
cc @thestinger for the tutorial parts. |
| Objects are never accessible after their destructor has been called, so there | ||
| are no dynamic failures from accessing freed resources. When a task fails, the | ||
| Destructors are only called once an object is inaccessible, so no dynamic | ||
| failures are possible from accessing freed resources. When a task fails, |
There was a problem hiding this comment.
This change does not mean precisely the same thing as the original sentence. In particular, the original phrasing indicates that inaccessibility is a property you get after the destructor has finished. (The new phrasing could be misinterpreted as meaning that the object is inaccessible even from the destructor itself. Of course this is not true, but the potential for such misinterpretation could cause confusion.)
There was a problem hiding this comment.
The insertion of the word "otherwise" before "inaccessible" would be one way to remedy that concern, but it's heading into the domain of wordiness.
Also no longer reference mutable fields
This is literally a copy-paste, there's no need to have this duplication.
bors
added a commit
that referenced
this pull request
Dec 10, 2013
Many of them are small. Will squash on request, but I feel like it's easier for everyone (easier to see and back out individual changes) this way.
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.
Many of them are small. Will squash on request, but I feel like it's easier
for everyone (easier to see and back out individual changes) this way.