From 1bb607b286a90f8e68fb025f5d680de48fcd0d60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8E=8B=E5=93=88=E5=93=88?= <31426858+wanghaha-dev@users.noreply.github.com> Date: Thu, 10 Nov 2022 18:22:37 +0800 Subject: [PATCH] Modify comment syntax error (#5094) --- adapter/context/input.go | 2 +- adapter/orm/orm_conds.go | 6 +++--- client/httplib/error_code.go | 6 +++--- client/httplib/httplib.go | 2 +- client/orm/db.go | 4 ++-- client/orm/db_mysql.go | 2 +- client/orm/orm_conds.go | 6 +++--- client/orm/orm_queryset.go | 2 +- client/orm/types.go | 2 +- core/config/ini.go | 2 +- core/logs/es/es.go | 4 ++-- server/web/captcha/siprng.go | 2 +- server/web/context/input.go | 2 +- server/web/session/sess_utils.go | 2 +- server/web/template.go | 2 +- task/task.go | 2 +- 16 files changed, 24 insertions(+), 24 deletions(-) diff --git a/adapter/context/input.go b/adapter/context/input.go index ac3e0c72..def81bf8 100644 --- a/adapter/context/input.go +++ b/adapter/context/input.go @@ -94,7 +94,7 @@ func (input *BeegoInput) IsHead() bool { return (*context.BeegoInput)(input).IsHead() } -// IsOptions Is this a OPTIONS method request? +// IsOptions Is this an OPTIONS method request? func (input *BeegoInput) IsOptions() bool { return (*context.BeegoInput)(input).IsOptions() } diff --git a/adapter/orm/orm_conds.go b/adapter/orm/orm_conds.go index 387caac2..4a713fcd 100644 --- a/adapter/orm/orm_conds.go +++ b/adapter/orm/orm_conds.go @@ -52,7 +52,7 @@ func (c *Condition) AndCond(cond *Condition) *Condition { return (*Condition)((*orm.Condition)(c).AndCond((*orm.Condition)(cond))) } -// AndNotCond combine a AND NOT condition to current condition +// AndNotCond combine an AND NOT condition to current condition func (c *Condition) AndNotCond(cond *Condition) *Condition { return (*Condition)((*orm.Condition)(c).AndNotCond((*orm.Condition)(cond))) } @@ -67,12 +67,12 @@ func (c Condition) OrNot(expr string, args ...interface{}) *Condition { return (*Condition)((orm.Condition)(c).OrNot(expr, args...)) } -// OrCond combine a OR condition to current condition +// OrCond combine an OR condition to current condition func (c *Condition) OrCond(cond *Condition) *Condition { return (*Condition)((*orm.Condition)(c).OrCond((*orm.Condition)(cond))) } -// OrNotCond combine a OR NOT condition to current condition +// OrNotCond combine an OR NOT condition to current condition func (c *Condition) OrNotCond(cond *Condition) *Condition { return (*Condition)((*orm.Condition)(c).OrNotCond((*orm.Condition)(cond))) } diff --git a/client/httplib/error_code.go b/client/httplib/error_code.go index f87041e4..43a68186 100644 --- a/client/httplib/error_code.go +++ b/client/httplib/error_code.go @@ -19,17 +19,17 @@ import ( ) var InvalidUrl = berror.DefineCode(4001001, moduleName, "InvalidUrl", ` -You pass a invalid url to httplib module. Please check your url, be careful about special character. +You pass an invalid url to httplib module. Please check your url, be careful about special character. `) var InvalidUrlProtocolVersion = berror.DefineCode(4001002, moduleName, "InvalidUrlProtocolVersion", ` -You pass a invalid protocol version. In practice, we use HTTP/1.0, HTTP/1.1, HTTP/1.2 +You pass an invalid protocol version. In practice, we use HTTP/1.0, HTTP/1.1, HTTP/1.2 But something like HTTP/3.2 is valid for client, and the major version is 3, minor version is 2. but you must confirm that server support those abnormal protocol version. `) var UnsupportedBodyType = berror.DefineCode(4001003, moduleName, "UnsupportedBodyType", ` -You use a invalid data as request body. +You use an invalid data as request body. For now, we only support type string and byte[]. `) diff --git a/client/httplib/httplib.go b/client/httplib/httplib.go index 147f595b..a9347395 100644 --- a/client/httplib/httplib.go +++ b/client/httplib/httplib.go @@ -112,7 +112,7 @@ func Head(url string) *BeegoHTTPRequest { return NewBeegoRequest(url, "HEAD") } -// BeegoHTTPRequest provides more useful methods than http.Request for requesting a url. +// BeegoHTTPRequest provides more useful methods than http.Request for requesting an url. type BeegoHTTPRequest struct { url string req *http.Request diff --git a/client/orm/db.go b/client/orm/db.go index 08047a04..cbaa81ad 100644 --- a/client/orm/db.go +++ b/client/orm/db.go @@ -1111,7 +1111,7 @@ func (d *dbBase) ReadBatch(ctx context.Context, q dbQuerier, qs *querySet, mi *m ind.Set(mind) } else { if cnt == 0 { - // you can use a empty & caped container list + // you can use an empty & caped container list // orm will not replace it if ind.Len() != 0 { // if container is not empty @@ -1135,7 +1135,7 @@ func (d *dbBase) ReadBatch(ctx context.Context, q dbQuerier, qs *querySet, mi *m ind.Set(slice) } else { // when a result is empty and container is nil - // to set a empty container + // to set an empty container if ind.IsNil() { ind.Set(reflect.MakeSlice(ind.Type(), 0, 0)) } diff --git a/client/orm/db_mysql.go b/client/orm/db_mysql.go index 5b3333e0..75d24b2a 100644 --- a/client/orm/db_mysql.go +++ b/client/orm/db_mysql.go @@ -155,7 +155,7 @@ func (d *dbBaseMysql) InsertOrUpdate(ctx context.Context, q dbQuerier, mi *model if isMulti { qmarks = strings.Repeat(qmarks+"), (", multi-1) + qmarks } - // conflitValue maybe is a int,can`t use fmt.Sprintf + // conflitValue maybe is an int,can`t use fmt.Sprintf query := fmt.Sprintf("INSERT INTO %s%s%s (%s%s%s) VALUES (%s) %s "+qupdates, Q, mi.table, Q, Q, columns, Q, qmarks, iouStr) d.ins.ReplaceMarks(&query) diff --git a/client/orm/orm_conds.go b/client/orm/orm_conds.go index 7d6eabe2..9946e595 100644 --- a/client/orm/orm_conds.go +++ b/client/orm/orm_conds.go @@ -90,7 +90,7 @@ func (c *Condition) AndCond(cond *Condition) *Condition { return c } -// AndNotCond combine a AND NOT condition to current condition +// AndNotCond combine an AND NOT condition to current condition func (c *Condition) AndNotCond(cond *Condition) *Condition { c = c.clone() if c == cond { @@ -121,7 +121,7 @@ func (c Condition) OrNot(expr string, args ...interface{}) *Condition { return &c } -// OrCond combine a OR condition to current condition +// OrCond combine an OR condition to current condition func (c *Condition) OrCond(cond *Condition) *Condition { c = c.clone() if c == cond { @@ -133,7 +133,7 @@ func (c *Condition) OrCond(cond *Condition) *Condition { return c } -// OrNotCond combine a OR NOT condition to current condition +// OrNotCond combine an OR NOT condition to current condition func (c *Condition) OrNotCond(cond *Condition) *Condition { c = c.clone() if c == cond { diff --git a/client/orm/orm_queryset.go b/client/orm/orm_queryset.go index 9f7b8441..82325899 100644 --- a/client/orm/orm_queryset.go +++ b/client/orm/orm_queryset.go @@ -257,7 +257,7 @@ func (o *querySet) DeleteWithCtx(ctx context.Context) (int64, error) { return o.orm.alias.DbBaser.DeleteBatch(ctx, o.orm.db, o, o.mi, o.cond, o.orm.alias.TZ) } -// return a insert queryer. +// return an insert queryer. // it can be used in times. // example: // i,err := sq.PrepareInsert() diff --git a/client/orm/types.go b/client/orm/types.go index 145f2897..df50a500 100644 --- a/client/orm/types.go +++ b/client/orm/types.go @@ -405,7 +405,7 @@ type QuerySeter interface { // //delete two user who's name is testing1 or testing2 Delete() (int64, error) DeleteWithCtx(context.Context) (int64, error) - // return a insert queryer. + // return an insert queryer. // it can be used in times. // example: // i,err := sq.PrepareInsert() diff --git a/core/config/ini.go b/core/config/ini.go index e3a395e5..d4dea2e3 100644 --- a/core/config/ini.go +++ b/core/config/ini.go @@ -98,7 +98,7 @@ func (ini *IniConfig) parseData(dir string, data []byte) (*IniConfigContainer, e break } - // It might be a good idea to throw a error on all unknonw errors? + // It might be a good idea to throw an error on all unknonw errors? if _, ok := err.(*os.PathError); ok { return nil, err } diff --git a/core/logs/es/es.go b/core/logs/es/es.go index 2073ab3d..a07ee83c 100644 --- a/core/logs/es/es.go +++ b/core/logs/es/es.go @@ -105,11 +105,11 @@ func (el *esLogger) WriteMsg(lm *logs.LogMsg) error { return err } -// Destroy is a empty method +// Destroy is an empty method func (el *esLogger) Destroy() { } -// Flush is a empty method +// Flush is an empty method func (el *esLogger) Flush() { } diff --git a/server/web/captcha/siprng.go b/server/web/captcha/siprng.go index 5e256cf9..4fdf3143 100644 --- a/server/web/captcha/siprng.go +++ b/server/web/captcha/siprng.go @@ -27,7 +27,7 @@ type siprng struct { k0, k1, ctr uint64 } -// siphash implements SipHash-2-4, accepting a uint64 as a message. +// siphash implements SipHash-2-4, accepting an uint64 as a message. func siphash(k0, k1, m uint64) uint64 { // Initialization. v0 := k0 ^ 0x736f6d6570736575 diff --git a/server/web/context/input.go b/server/web/context/input.go index 241ef8bc..dfb14dfb 100644 --- a/server/web/context/input.go +++ b/server/web/context/input.go @@ -153,7 +153,7 @@ func (input *BeegoInput) IsHead() bool { return input.Is("HEAD") } -// IsOptions Is this a OPTIONS method request? +// IsOptions Is this an OPTIONS method request? func (input *BeegoInput) IsOptions() bool { return input.Is("OPTIONS") } diff --git a/server/web/session/sess_utils.go b/server/web/session/sess_utils.go index 23242d7a..b2649336 100644 --- a/server/web/session/sess_utils.go +++ b/server/web/session/sess_utils.go @@ -98,7 +98,7 @@ func encrypt(block cipher.Block, value []byte) ([]byte, error) { // decrypt decrypts a value using the given block in counter mode. // -// The value to be decrypted must be prepended by a initialization vector +// The value to be decrypted must be prepended by an initialization vector // (http://goo.gl/zF67k) with the length of the block size. func decrypt(block cipher.Block, value []byte) ([]byte, error) { size := block.BlockSize() diff --git a/server/web/template.go b/server/web/template.go index c683c565..715c992d 100644 --- a/server/web/template.go +++ b/server/web/template.go @@ -103,7 +103,7 @@ func init() { beegoTplFuncMap["lt"] = lt // < beegoTplFuncMap["ne"] = ne // != - beegoTplFuncMap["urlfor"] = URLFor // build a URL to match a Controller and it's method + beegoTplFuncMap["urlfor"] = URLFor // build an URL to match a Controller and it's method } // AddFuncMap let user to register a func in the template. diff --git a/task/task.go b/task/task.go index 7001b9ed..91b8d2f8 100644 --- a/task/task.go +++ b/task/task.go @@ -221,7 +221,7 @@ func (f optionFunc) apply(t *Task) { f(t) } -// TimeoutOption return a option to set timeout duration for task +// TimeoutOption return an option to set timeout duration for task func TimeoutOption(timeout time.Duration) Option { return optionFunc(func(t *Task) { t.Timeout = timeout