[DOC] Enhanced RDoc for Logger #77
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
lib/logger.rb
Outdated
| # 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?
lib/logger.rb
Outdated
| # | ||
| def reopen(logdev = nil) | ||
| @logdev&.reopen(logdev) | ||
| 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).
lib/logger.rb
Outdated
| # 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
approved these changes
May 13, 2022
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
May 13, 2022
Enhanced RDoc for Logger ruby/logger@c601ed0370 Co-authored-by: Peter Zhu <peter@peterzhu.ca>
schneems
pushed a commit
to schneems/ruby
that referenced
this pull request
May 23, 2022
Enhanced RDoc for Logger ruby/logger@c601ed0370 Co-authored-by: Peter Zhu <peter@peterzhu.ca>
schneems
pushed a commit
to schneems/ruby
that referenced
this pull request
Jul 26, 2022
Enhanced RDoc for Logger ruby/logger@c601ed0370 Co-authored-by: Peter Zhu <peter@peterzhu.ca>
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.
This covers the methods and accessors, along with further changes and reorgs in the class doc itself.