From 8881b2a529fdfc66ee7921414024f93c8f4e7398 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Thu, 20 Apr 2023 16:52:48 +0200 Subject: [PATCH] api/writer.go: add documentation about low-level interface --- api/writer.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api/writer.go b/api/writer.go index 953d7d7..4cfc8b2 100644 --- a/api/writer.go +++ b/api/writer.go @@ -2,6 +2,8 @@ package api // Writer interface defines the required methods // to send messages over an channel. +// +// This is a low-level interface typically implemented by backend drivers type Writer interface { // Write writes a message over a channel. // The message may or may not be buffered depending on the implementation.