From 94bfc8121cc9d8d65feb50ae56bbe8941d5f81bd Mon Sep 17 00:00:00 2001
From: Brian Tiger Chow <brian.holderchow@gmail.com>
Date: Mon, 17 Nov 2014 01:27:24 -0800
Subject: [PATCH] docs(eventlog/formatter)

@jbenet

License: MIT
Signed-off-by: Brian Tiger Chow <brian@perfmode.com>
---
 util/eventlog/polite_json_formatter.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/util/eventlog/polite_json_formatter.go b/util/eventlog/polite_json_formatter.go
index 509f0871b..d206f5d99 100644
--- a/util/eventlog/polite_json_formatter.go
+++ b/util/eventlog/polite_json_formatter.go
@@ -7,6 +7,8 @@ import (
 	"github.com/jbenet/go-ipfs/Godeps/_workspace/src/github.com/maybebtc/logrus"
 )
 
+// PoliteJSONFormatter marshals entries into JSON encoded slices (without
+// overwriting user-provided keys). How polite of it!
 type PoliteJSONFormatter struct{}
 
 func (f *PoliteJSONFormatter) Format(entry *logrus.Entry) ([]byte, error) {