From 99f30eff97ce6d836f3e74d8d644aab0388363b6 Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Sat, 10 Oct 2015 02:17:00 -0700 Subject: [PATCH] added some docs. removed some whitespace. --- discard_router.go | 6 ++++++ discard_router_test.go | 1 - 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/discard_router.go b/discard_router.go index a7ab8ff..9fe7895 100644 --- a/discard_router.go +++ b/discard_router.go @@ -5,11 +5,17 @@ var ( singltonDiscardRouter = DiscardRouter{} ) + +// NewDiscardRouter returns an initialized DiscardRouter. func NewDiscardRouter() *DiscardRouter { return &singltonDiscardRouter } +// DiscardRouter is a Router that discards any message (and its context) +// it is asked to route. +// +// Conceptually it is similar to /dev/null type DiscardRouter struct{} diff --git a/discard_router_test.go b/discard_router_test.go index 5b1a2d1..9644a37 100644 --- a/discard_router_test.go +++ b/discard_router_test.go @@ -12,5 +12,4 @@ func TestNewDiscardRouter(t *testing.T) { if nil == router { t.Errorf("After trying to create a discard router, expected it to be not nil, but was: %v", router) } - }