From 02e6e0891476842fbd86dedbc347dd58b16304c5 Mon Sep 17 00:00:00 2001 From: Cameron Moore Date: Thu, 14 Dec 2017 18:50:01 -0600 Subject: [PATCH] Fix godoc comment Bullets don't work well in godoc. Just use prose. --- protocol.go | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/protocol.go b/protocol.go index 5765072..38bb6cb 100644 --- a/protocol.go +++ b/protocol.go @@ -28,12 +28,13 @@ var ( // passed in as an argument. If the function returns an error due to the source // being disallowed, it should return ErrInvalidUpstream. // -// Behavior is as follows: -// * If error is not nil, the call to Accept() will fail. If the reason for +// If error is not nil, the call to Accept() will fail. If the reason for // triggering this failure is due to a disallowed source, it should return // ErrInvalidUpstream. -// * If bool is true, the PROXY-set address is used. -// * If bool is false, the connection's remote address is used, rather than the +// +// If bool is true, the PROXY-set address is used. +// +// If bool is false, the connection's remote address is used, rather than the // address claimed in the PROXY info. type SourceChecker func(net.Addr) (bool, error)