summaryrefslogtreecommitdiffstats
path: root/common
diff options
context:
space:
mode:
authorOleksandr Redko <Oleksandr_Redko@epam.com>2023-05-18 12:05:56 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-05-18 21:25:27 +0200
commit610cedaa61cf1f318ecd4a7818a896b1e56e7662 (patch)
tree3c206f0386b05b44ec1f3bd00f9d96f6904c8446 /common
parent24e7d0c174a24a016f65be46765ab9c795e1e123 (diff)
all: Fix comments for exported functions and packages
Diffstat (limited to 'common')
-rw-r--r--common/herrors/errors.go2
-rw-r--r--common/herrors/file_error.go2
-rw-r--r--common/maps/params.go4
3 files changed, 4 insertions, 4 deletions
diff --git a/common/herrors/errors.go b/common/herrors/errors.go
index 822271ef2..4d8642362 100644
--- a/common/herrors/errors.go
+++ b/common/herrors/errors.go
@@ -49,7 +49,7 @@ func Recover(args ...any) {
}
}
-// Get the current goroutine id. Used only for debugging.
+// GetGID the current goroutine id. Used only for debugging.
func GetGID() uint64 {
b := make([]byte, 64)
b = b[:runtime.Stack(b, false)]
diff --git a/common/herrors/file_error.go b/common/herrors/file_error.go
index 9273b2a80..30417897f 100644
--- a/common/herrors/file_error.go
+++ b/common/herrors/file_error.go
@@ -35,7 +35,7 @@ import (
type FileError interface {
error
- // ErroContext holds some context information about the error.
+ // ErrorContext holds some context information about the error.
ErrorContext() *ErrorContext
text.Positioner
diff --git a/common/maps/params.go b/common/maps/params.go
index a3e607b89..d94d16f9d 100644
--- a/common/maps/params.go
+++ b/common/maps/params.go
@@ -37,7 +37,7 @@ func (p Params) GetNested(indices ...string) any {
return v
}
-// Set overwrites values in dst with values in src for common or new keys.
+// SetParams overwrites values in dst with values in src for common or new keys.
// This is done recursively.
func SetParams(dst, src Params) {
for k, v := range src {
@@ -83,7 +83,7 @@ func MergeParamsWithStrategy(strategy string, dst, src Params) {
dst.merge(ParamsMergeStrategy(strategy), src)
}
-// MergeParamsWithStrategy transfers values from src to dst for new keys using the merge encoded in dst.
+// MergeParams transfers values from src to dst for new keys using the merge encoded in dst.
// This is done recursively.
func MergeParams(dst, src Params) {
ms, _ := dst.GetMergeStrategy()