Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed stdout documentation to detail the 's' paramater #39

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Changed stdout documentation to detail the 's' paramater #39

wants to merge 1 commit into from

Conversation

tomkadwill
Copy link

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 :)

@@ -902,7 +902,7 @@ def stdout
@stdout
end

# Sets the IO used as stdout. Defaults to STDOUT

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stdout is more readable. wdyt about changing this to

# Sets the IO used as +stdout+. Defaults to STDOUT
      def stdout=(stdout)
        @stdout = stdout
      end

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@tomkadwill
Copy link
Author

Any update on this? I would like to carry on documenting debug.rb but not sure if this change is good :)

/cc @zzak @nobu

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants