From 6a45a8586d8467f1145b70e16ad35fec46bf1151 Mon Sep 17 00:00:00 2001 From: Holger Just Date: Fri, 22 Sep 2017 23:17:59 +0200 Subject: [PATCH] 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. --- lib/rackstash/flow.rb | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/rackstash/flow.rb b/lib/rackstash/flow.rb index 5fe67d3..0cde76a 100644 --- a/lib/rackstash/flow.rb +++ b/lib/rackstash/flow.rb @@ -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