adding description of return value [ci skip] #21480
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
|
r? @pixeltrix (@rails-bot has picked a reviewer for you, use r? to override) |
amitsuroliya
force-pushed
the
add_return_value_description
branch
from
d8418c0
to
edc94b7
Compare
|
Hello @amitsuroliya! You are right that the sentence doesn't read well, but stating that the method returns true or false might be misinterpreted as the actual values Maybe @fxn can chime in here. We could also just say
|
|
"true" and "false" have a well-defined meaning in our documentation.. but I agree the "whether" version reads better. |
amitsuroliya
force-pushed
the
add_return_value_description
branch
from
edc94b7
to
ddc05b6
Compare
| @@ -141,7 +141,7 @@ def initialize(source, identifier, handler, details) | |||
| @compile_mutex = Mutex.new | |||
| end | |||
|
|
|||
| # Returns if the underlying handler supports streaming. If so, | |||
| # Returns whether the underlying handler supports streaming. If so, | |||
| # a streaming buffer *may* be passed when it start rendering. | |||
There was a problem hiding this comment.
Since we're touching this anyway it would be great to expand the *may*. I don't understand what that means.
|
👍 to "whether". |
kaspth
added a commit
that referenced
this pull request
Sep 7, 2015
adding description of return value [ci skip]
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.
No description provided.