Faq tweaks: batch 1 #2
Merged
Conversation
This file contains 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
| If you're looking for a way to avoid handling [`Result`s][Result] in other people's code, there's always [`unwrap()`][unwrap], but it's probably not what you want. [`Result`][Result] is an indicator that some computation may or may not complete successfully. Requiring you to handle these failures explicitly is one of the ways that Rust encourages robustness. If you really don't want to handle an error, use [`unwrap()`][unwrap], but know that doing so means that the given code will cause the entire process to panic on failure, which is usually undesirable. | ||
| If you're looking for a way to avoid handling [`Result`s][Result] in other people's code, there's always [`unwrap()`][unwrap], but it's probably not what you want. [`Result`][Result] is an indicator that some computation may or may not complete successfully. Requiring you to handle these failures explicitly is one of the ways that Rust encourages robustness. Rust provides tools like the [`try!` macro][TryMacro] to make handling failures ergonomic. | ||
|
|
||
| If you really don't want to handle an error, use [`unwrap()`][unwrap], but know that doing so means that the given code will cause the entire process to panic on failure, which is usually undesirable. |
There was a problem hiding this comment.
nit: "entire thread" is more accurate
|
@glaebhoerl Thanks! Pushed a new commit to address your comments. |
| @@ -155,7 +162,7 @@ fn is_odd(x: i64) -> bool { | |||
| } | |||
| ``` | |||
|
|
|||
| In each example, the last line of the function is the return value of that function. It is important to note that if a function ends in a semicolon, its return type will be `()`, indicating no returned value. Implicit returns must omit the semicolon to work. | |||
| In each example, the last line of the function is the return value of that function. It is important to note that if a block ends in a semicolon, its return type will be `()`, indicating no returned value. Implicit returns must omit the semicolon to work. | |||
There was a problem hiding this comment.
Here you changed 'function' to 'block' while the rest of the sentence talks about 'return' types. I don't typically think of blocks as 'returning' something and haven't seen 'return' used this way. The preceding sentence is also talking about functions.
There was a problem hiding this comment.
Hm, good point. To be honest I've never found the concept of "implicit return" to be a helpful way to think about what's going on here. Anyway, I'll back out this particular change.
|
Thanks. These are good improvements. |
brson
pushed a commit
that referenced
this pull request
Jan 20, 2016
Tweaks to the community and user groups page
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.
Here's my first batch of edits to the FAQ, covering up through "Design Patterns".
I plan to get through the rest and open a second PR later today.
r? @brson @AndrewBrinker