docs: improve API performance and testing robustness

appleboy · appleboy · commit b95a398fd4ef · 2024-11-09T11:59:51.000+08:00
- Add a comment describing the `Fn` function which retrieves zap fields from `gin.Context`

Signed-off-by: appleboy &lt;appleboy.tw@gmail.com&gt;
diff --git a/zap.go b/zap.go
@@ -17,6 +17,7 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
+// Fn is a function to get zap fields from gin.Context
 type Fn func(c *gin.Context) []zapcore.Field
 
 // Skipper is a function to skip logs based on provided Context

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ import (`
`17`	`17`	`"go.uber.org/zap/zapcore"`
`18`	`18`	`)`
`19`	`19`
	`20`	`+// Fn is a function to get zap fields from gin.Context`
`20`	`21`	`type Fn func(c *gin.Context) []zapcore.Field`
`21`	`22`
`22`	`23`	`// Skipper is a function to skip logs based on provided Context`