Changed stdout documentation to detail the 's' paramater - #39
Open
tomkadwill wants to merge 1 commit into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Comment thread
lib/debug.rb
Copy link
Copy Markdown
There was a problem hiding this comment.
stdout is more readable. wdyt about changing this to
# Sets the IO used as +stdout+. Defaults to STDOUT
def stdout=(stdout)
@stdout = stdout
end
Sorry, something went wrong.
Copy link
Copy Markdown
Author
There was a problem hiding this comment.
@vipulnsward Yes I think that does look better. I was thinking about that but didn't know whether it was called s for a reason. I've updated my PR to reflect the change that you suggested.
Sorry, something went wrong.
Copy link
Copy Markdown
Author
|
Any update on this? I would like to carry on documenting debug.rb but not sure if this change is good :) |
Sorry, something went wrong.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changed stdout documentation to reference the s parameter. stdout will no longer be flagged by rdoc as having an undocumented parameter.
This is my first Ruby documentation commit so let me know if I need to change anything :)