Merge pull request #165 from CodeLingoBot/rewrite

Fix function comments based on best practices from Effective Go
mailgun · Mar 13, 2019 · cec7cf5 · cec7cf5
2 parents 15f1246 + bbaf3d7
commit cec7cf5
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/config/config.go b/config/config.go
@@ -327,12 +327,12 @@ func DefaultApp(cluster string) *App {
 	return appCfg
 }
 
-// DefaultCluster returns configuration used by default.
+// DefaultProxy returns configuration used by default.
 func DefaultProxy() *Proxy {
 	return defaultProxyWithClientID(newClientID())
 }
 
-// FromYAML parses configuration from a YAML file and performs basic
+// FromYAMLFile parses configuration from a YAML file and performs basic
 // validation of parameters.
 func FromYAMLFile(filename string) (*App, error) {
 	configFile, err := os.Open(filename)

diff --git a/server/grpcsrv/grpcsrv.go b/server/grpcsrv/grpcsrv.go
@@ -54,7 +54,7 @@ func New(addr string, proxySet *proxy.Set) (*T, error) {
 	return &s, nil
 }
 
-// Starts triggers asynchronous gRPC server start. If it fails then the error
+// Start starts triggers asynchronous gRPC server start. If it fails then the error
 // will be sent down to `ErrorCh()`.
 func (s *T) Start() {
 	actor.Spawn(s.actDesc, &s.wg, func() {

diff --git a/server/httpsrv/httpsrv.go b/server/httpsrv/httpsrv.go
@@ -131,7 +131,7 @@ func New(addr string, proxySet *proxy.Set) (*T, error) {
 	return hs, nil
 }
 
-// Starts triggers asynchronous HTTP server start. If it fails then the error
+// Start starts triggers asynchronous HTTP server start. If it fails then the error
 // will be sent down to `ErrorCh()`.
 func (s *T) Start() {
 	actor.Spawn(s.actDesc, &s.wg, func() {