Skip to content

Commit 4c7b620

Browse files
committed
Update go docs of fundamental packages
Signed-off-by: Eric Zhao <[email protected]>
1 parent 963192c commit 4c7b620

File tree

8 files changed

+13
-3
lines changed

8 files changed

+13
-3
lines changed

core/config/config.go

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ func ResetGlobalConfig(config *Entity) {
2222
globalCfg = config
2323
}
2424

25+
// InitConfigWithYaml loads general configuration from the YAML file under provided path.
2526
func InitConfigWithYaml(filePath string) (err error) {
2627
// Initialize general config and logging module.
2728
if err = applyYamlConfigFile(filePath); err != nil {

core/config/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package config provides general configuration mechanism.
2+
package config

core/hotspot/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package hotspot provides implementation of "hot-spot" (frequent) parameter flow control.
2+
package hotspot

core/isolation/doc.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
// Package isolation implements the concurrency traffic control.
2-
1+
// Package isolation provides implementation of concurrency limiting (semaphore isolation).
32
package isolation

core/isolation/slot.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func (s *Slot) Check(ctx *base.EntryContext) *base.TokenResult {
3333
return result
3434
}
3535
if passed, rule, snapshot := checkPass(ctx); !passed {
36-
msg := "isolation check blocked"
36+
msg := "concurrency exceeds threshold"
3737
if result == nil {
3838
result = base.NewTokenResultBlockedWithCause(base.BlockTypeIsolation, msg, rule, snapshot)
3939
} else {

core/stat/base/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package stat/base provides fundamental data structures of statistics.
2+
package base

core/system/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package system provides implementation of adaptive system protection.
2+
package system

ext/datasource/doc.go

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package ext/datasource provides interfaces and helper classes of dynamic data-source.
2+
package datasource

0 commit comments

Comments
 (0)