Skip to content

Commit 25df1ed

Browse files
committed
[DOC] Missing descriptions of Logger.new arguments
1 parent 0892e1a commit 25df1ed

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

lib/logger.rb

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,16 @@ def fatal!; self.level = FATAL; end
547547
# entries are to be written to the given stream.
548548
# - +nil+ or +File::NULL+: no entries are to be written.
549549
#
550+
# Argument +shift_age+ must be on of:
551+
#
552+
# - The number of log files to be in the rotation.
553+
# See {Size-Based Rotation}[rdoc-ref:Logger@Size-Based+Rotation].
554+
# - A string period indicator.
555+
# See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
556+
#
557+
# Argument +shift_size+ is the maximum size (in bytes) of each log file.
558+
# See {Size-Based Rotation}[rdoc-ref:Logger@Size-Based+Rotation].
559+
#
550560
# Examples:
551561
#
552562
# Logger.new('t.log')
@@ -566,14 +576,18 @@ def fatal!; self.level = FATAL; end
566576
#
567577
# - +formatter+: sets the entry formatter; default is +nil+.
568578
# See {formatter=}[Logger.html#attribute-i-formatter].
579+
#
569580
# - +datetime_format+: sets the format for entry timestamp;
570581
# default is +nil+.
571582
# See #datetime_format=.
583+
#
572584
# - +binmode+: sets whether the logger writes in binary mode;
573585
# default is +false+.
586+
#
574587
# - +shift_period_suffix+: sets the format for the filename suffix
575588
# for periodic log file rotation; default is <tt>'%Y%m%d'</tt>.
576589
# See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
590+
#
577591
# - +reraise_write_errors+: An array of exception classes, which will
578592
# be reraised if there is an error when writing to the log device.
579593
# The default is to swallow all exceptions raised.

0 commit comments

Comments
 (0)