Clarify "It is an error to..." wording for zero-duration behaviors. #48328
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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
r? @sfackler i'm interested in doing the integration test thing you mentioned in the github issue, but i'll do that in a separate pr |
frewsxcv
force-pushed
the
frewsxcv-clarify-error-zero-duration
branch
from
88973b6
to
19fa3da
Compare
sfackler
reviewed
Feb 18, 2018
| @@ -282,6 +284,20 @@ impl TcpStream { | |||
| /// .expect("Couldn't connect to the server..."); | |||
| /// stream.set_read_timeout(None).expect("set_read_timeout call failed"); | |||
| /// ``` | |||
| /// | |||
| /// An [`Err`] is returned if the zero [`Duration`] is passed to this | |||
There was a problem hiding this comment.
I don't know if we need to have an explicit example of an invalid call.
There was a problem hiding this comment.
We talked about it at the docs team meeting, and everyone was generally in favor of showing off error conditions.
frewsxcv
force-pushed
the
frewsxcv-clarify-error-zero-duration
branch
from
19fa3da
to
bb2fae6
Compare
frewsxcv
force-pushed
the
frewsxcv-clarify-error-zero-duration
branch
from
bb2fae6
to
931087c
Compare
|
☔ The latest upstream changes (presumably #48399) made this pull request unmergeable. Please resolve the merge conflicts. |
bors
added
S-waiting-on-author
Documentation fix side of rust-lang#48311.
frewsxcv
force-pushed
the
frewsxcv-clarify-error-zero-duration
branch
from
931087c
to
0700bd1
Compare
|
tests are passing now, let me know if anyone sees anything else! |
shepmaster
added
S-waiting-on-review
|
Heads-up @sfackler, this is ready for re-review. |
|
@bors r+ |
|
📌 Commit 0700bd1 has been approved by |
bors
added
S-waiting-on-bors
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Mar 3, 2018
…o-duration, r=sfackler Fixes rust-lang#47311. r? @nrc
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.
Documentation fix side of #48311.