1
0
mirror of https://github.com/meineerde/rackstash.git synced 2026-02-05 00:23:22 +00:00

Remove "@api private" tag from Flow#write documentation

Any public method is part of the public interface of the class and thus
needs to be equally well supported. Only because methods are not usually
called by end-users, we still need to properly document, test, and check
them.
This commit is contained in:
Holger Just 2017-09-22 23:17:59 +02:00
parent 1711b0d589
commit 6a45a8586d

View File

@ -206,8 +206,6 @@ module Rackstash
# 3. Finally, the encoded event will be passed to the {#adapter} to be send
# to the actual log target, e.g. a file or an external log receiver.
#
# @api private
#
# @param event [Hash] an event hash
# @return [Boolean] `true` if the event was written to the adapter, `false`
# otherwise