From 54414db91d7dd78354c5b767f99c0d233af79f45 Mon Sep 17 00:00:00 2001 From: Kevin Wan Date: Mon, 8 Feb 2021 21:31:56 +0800 Subject: [PATCH] fix golint issues, exported doc (#451) --- core/discov/internal/statewatcher.go | 1 + core/errorx/atomicerror.go | 3 +++ core/naming/namer.go | 1 + core/threading/routines.go | 4 +++- rest/handler/timeouthandler.go | 5 +++-- tools/goctl/api/gogen/template.go | 21 +++++++++++++-------- tools/goctl/kube/kube.go | 6 ++++++ tools/goctl/rpc/parser/package.go | 1 + 8 files changed, 31 insertions(+), 11 deletions(-) diff --git a/core/discov/internal/statewatcher.go b/core/discov/internal/statewatcher.go index dc0f0296..4618adb6 100644 --- a/core/discov/internal/statewatcher.go +++ b/core/discov/internal/statewatcher.go @@ -1,4 +1,5 @@ //go:generate mockgen -package internal -destination statewatcher_mock.go -source statewatcher.go etcdConn + package internal import ( diff --git a/core/errorx/atomicerror.go b/core/errorx/atomicerror.go index d885f489..bc52d54c 100644 --- a/core/errorx/atomicerror.go +++ b/core/errorx/atomicerror.go @@ -2,14 +2,17 @@ package errorx import "sync/atomic" +// AtomicError defines an atomic error. type AtomicError struct { err atomic.Value // error } +// Set sets the error. func (ae *AtomicError) Set(err error) { ae.err.Store(err) } +// Load returns the error. func (ae *AtomicError) Load() error { if v := ae.err.Load(); v != nil { return v.(error) diff --git a/core/naming/namer.go b/core/naming/namer.go index a1dd53f7..bb10b350 100644 --- a/core/naming/namer.go +++ b/core/naming/namer.go @@ -1,5 +1,6 @@ package naming +// Namer interface wraps the method Name. type Namer interface { Name() string } diff --git a/core/threading/routines.go b/core/threading/routines.go index 21bfcf77..4a20b364 100644 --- a/core/threading/routines.go +++ b/core/threading/routines.go @@ -8,11 +8,12 @@ import ( "github.com/tal-tech/go-zero/core/rescue" ) +// GoSafe runs the given fn using another goroutine, recovers if fn panics. func GoSafe(fn func()) { go RunSafe(fn) } -// Only for debug, never use it in production +// RoutineId is only for debug, never use it in production. func RoutineId() uint64 { b := make([]byte, 64) b = b[:runtime.Stack(b, false)] @@ -24,6 +25,7 @@ func RoutineId() uint64 { return n } +// RunSafe runs the given fn, recovers if fn panics. func RunSafe(fn func()) { defer rescue.Recover() diff --git a/rest/handler/timeouthandler.go b/rest/handler/timeouthandler.go index c8f0941d..bb53acb8 100644 --- a/rest/handler/timeouthandler.go +++ b/rest/handler/timeouthandler.go @@ -7,12 +7,13 @@ import ( const reason = "Request Timeout" +// TimeoutHandler returns the handler with given timeout. func TimeoutHandler(duration time.Duration) func(http.Handler) http.Handler { return func(next http.Handler) http.Handler { if duration > 0 { return http.TimeoutHandler(next, duration, reason) - } else { - return next } + + return next } } diff --git a/tools/goctl/api/gogen/template.go b/tools/goctl/api/gogen/template.go index c593ae24..e90268f5 100644 --- a/tools/goctl/api/gogen/template.go +++ b/tools/goctl/api/gogen/template.go @@ -26,10 +26,22 @@ var templates = map[string]string{ mainTemplateFile: mainTemplate, } +// Category returns the category of the api files. +func Category() string { + return category +} + +// Clean cleans the generated deployment files. +func Clean() error { + return util.Clean(category) +} + +// GenTemplates generates api template files. func GenTemplates(_ *cli.Context) error { return util.InitTemplates(category, templates) } +// RevertTemplate reverts the given template file to the default value. func RevertTemplate(name string) error { content, ok := templates[name] if !ok { @@ -38,6 +50,7 @@ func RevertTemplate(name string) error { return util.CreateTemplate(category, name, content) } +// Update updates the template files to the templates built in current goctl. func Update() error { err := Clean() if err != nil { @@ -46,11 +59,3 @@ func Update() error { return util.InitTemplates(category, templates) } - -func Clean() error { - return util.Clean(category) -} - -func Category() string { - return category -} diff --git a/tools/goctl/kube/kube.go b/tools/goctl/kube/kube.go index 9e646fa0..b1ddec95 100644 --- a/tools/goctl/kube/kube.go +++ b/tools/goctl/kube/kube.go @@ -36,6 +36,7 @@ type Deployment struct { MaxReplicas int } +// DeploymentCommand is used to generate the kubernetes deployment yaml files. func DeploymentCommand(c *cli.Context) error { nodePort := c.Int("nodePort") // 0 to disable the nodePort type @@ -80,14 +81,17 @@ func DeploymentCommand(c *cli.Context) error { return nil } +// Category returns the category of the deployments. func Category() string { return category } +// Clean cleans the generated deployment files. func Clean() error { return util.Clean(category) } +// GenTemplates generates the deployment template files. func GenTemplates(_ *cli.Context) error { return util.InitTemplates(category, map[string]string{ deployTemplateFile: deploymentTemplate, @@ -95,10 +99,12 @@ func GenTemplates(_ *cli.Context) error { }) } +// RevertTemplate reverts the given template file to the default value. func RevertTemplate(name string) error { return util.CreateTemplate(category, name, deploymentTemplate) } +// Update updates the template files to the templates built in current goctl. func Update() error { err := Clean() if err != nil { diff --git a/tools/goctl/rpc/parser/package.go b/tools/goctl/rpc/parser/package.go index 6a7abf88..0b0b9590 100644 --- a/tools/goctl/rpc/parser/package.go +++ b/tools/goctl/rpc/parser/package.go @@ -2,6 +2,7 @@ package parser import "github.com/emicklei/proto" +// Package defines the protobuf package. type Package struct { *proto.Package }