Uh oh!
There was an error while loading. Please reload this page.
[DOC] Enhanced RDoc for Logger - #77
Conversation
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| # Reopen a log device. | ||
| # Sets the logger's output stream: | ||
| # | ||
| # - If +logdev+ is +nil+, reopens the already-established output stream. |
There was a problem hiding this comment.
I'm a bit confused as to what "already-established" means. Do you think "current" is a better word to use?
Uh oh!
There was an error while loading. Please reload this page.
| self | ||
| end | ||
| # Creates a log entry (which may or may not be written to the log). |
There was a problem hiding this comment.
I think we should be clear that it "may or may not be written to the log" because of the log level (and not because it does sampling or intermittently fails or some other reason).
| # When you call instance method #add (or its alias #log), | ||
| # an entry may (or may not) be written to the log; | ||
| # When you call any of these methods, | ||
| # the entry may (or may not) be written to the log; |
There was a problem hiding this comment.
Ditto on clarifying the "may or may not".
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
peterzhu2118
left a comment
There was a problem hiding this comment.
Looks good.
Could you use the "Squash and merge" button when merging to squash all of the commits into one?
Enhanced RDoc for Logger ruby/logger@c601ed0370 Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Enhanced RDoc for Logger ruby/logger@c601ed0370 Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Enhanced RDoc for Logger ruby/logger@c601ed0370 Co-authored-by: Peter Zhu <peter@peterzhu.ca>
This covers the methods and accessors, along with further changes and reorgs in the class doc itself.