add doc string

gojekfarm · May 18, 2021 · 76636d5 · 76636d5
1 parent f1b7a32
commit 76636d5
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 11 deletions.
diff --git a/component/grpc_server.go b/component/grpc_server.go
@@ -8,6 +8,7 @@ import (
 	"google.golang.org/grpc"
 )
 
+// GRPCServerOptions holds options for GRPCServer
 type GRPCServerOptions struct {
 	Server   *grpc.Server
 	Listener net.Listener

diff --git a/component/grpc_server_test.go b/component/grpc_server_test.go
@@ -69,7 +69,7 @@ func (s *GRPCServerSuite) TestGRPCServer() {
 			}
 
 			s.NoError(m.Add(GRPCServer(GRPCServerOptions{
-				Server: srv,
+				Server:   srv,
 				Listener: l,
 				PreStart: func() {
 					s.T().Log("PreStart called")
@@ -119,13 +119,3 @@ func (m *mockListener) Close() error {
 func (m *mockListener) Addr() net.Addr {
 	return m.Called().Get(0).(net.Addr)
 }
-
-type badAddr struct{}
-
-func (b badAddr) Network() string {
-	return "tcp"
-}
-
-func (b badAddr) String() string {
-	return "bad address"
-}
diff --git a/component/http_server.go b/component/http_server.go
@@ -7,6 +7,7 @@ import (
 	"github.com/gojekfarm/xrun"
 )
 
+// HTTPServerOptions holds options for HTTPServer
 type HTTPServerOptions struct {
 	Server   *http.Server
 	PreStart func()