From 439913e5e421d13db3b7fd65028be32c3b98933a Mon Sep 17 00:00:00 2001
From: Tiago Peczenyj <tiago.peczenyj@gmail.com>
Date: Sun, 3 Dec 2023 19:41:54 +0100
Subject: [PATCH] Update klogrus.go

Improve existing documentation
---
 plugin/klogrus/klogrus.go | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/plugin/klogrus/klogrus.go b/plugin/klogrus/klogrus.go
index c317949b..fc9e54ff 100644
--- a/plugin/klogrus/klogrus.go
+++ b/plugin/klogrus/klogrus.go
@@ -13,6 +13,8 @@ var (
 )
 
 // FieldLogger interface.
+// combines logrus.FieldLogger with GetLevel method
+// useful to represent a wrapper around *logrus.Logger
 type FieldLogger interface {
 	logrus.FieldLogger
 	GetLevel() logrus.Level
@@ -30,6 +32,9 @@ func New(lr *logrus.Logger) *Logger {
 }
 
 // NewFieldLogger returns a new Logger using a FieldLogger interface.
+// it is isofunctional with New constructor, except it can accept either
+// *logrus.Logger or a possible wrapper thaf implements logrus.FieldLogger
+// and includes GetLevel method.
 func NewFieldLogger(fl FieldLogger) *Logger {
 	return &Logger{fl}
 }