meineerde/rackstash
1
0
Fork 0
mirror of https://github.com/meineerde/rackstash.git synced 2026-02-01 01:37:12 +00:00
Code Issues Releases Activity

Do not mention local methods of Buffer class in methods docs referenced by Logger

Browse Source
This commit is contained in:
Holger Just 2018-07-17 22:45:55 +02:00
parent d510280532
commit e592434eec
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/rackstash/buffer.rb
View File

@ -80,8 +80,8 @@ module Rackstash
clear
end
# Extract useful data from an exception and add it to fields of the buffer
# for structured logging. The following fields will be set:
# Extract useful data from an exception and add it to fields of the current
# buffer for structured logging. The following fields will be set:
#
# * `error` - The class name of the exception
# * `error_message` - The exception's message
@ -95,9 +95,9 @@ module Rackstash
# `false`, we will preserve existing exceptions.
#
# If a new exception was set, the buffer will be flushed to all
# auto_flushing flows automatically. If the buffer is not {#buffering?}, it
# will also be flushed to the non auto_flushing flows and cleared
# afterwards.
# auto_flushing flows automatically. If the buffer is not buffering log
# messages, it will also be flushed to the non auto_flushing flows and
# cleared afterwards.
#
# @param exception [Exception] an Exception object as caught by a
# `begin` ... `rescue` block.