chore: add comments

This commit is contained in:
Jason Song 2023-01-05 14:43:07 +08:00
parent 60173297aa
commit ede9a5f2fa
No known key found for this signature in database
GPG Key ID: 8402EEEE4511A8B5

View File

@ -30,6 +30,8 @@ import (
var methodCtxKey struct{} var methodCtxKey struct{}
// withMethod sets the notification method that this context currently executes.
// Used for debugging/ troubleshooting purposes.
func withMethod(ctx context.Context, method string) context.Context { func withMethod(ctx context.Context, method string) context.Context {
// don't overwrite // don't overwrite
if v := ctx.Value(methodCtxKey); v != nil { if v := ctx.Value(methodCtxKey); v != nil {
@ -40,6 +42,9 @@ func withMethod(ctx context.Context, method string) context.Context {
return context.WithValue(ctx, methodCtxKey, method) return context.WithValue(ctx, methodCtxKey, method)
} }
// getMethod gets the notification method that this context currently executes.
// Default: "notify"
// Used for debugging/ troubleshooting purposes.
func getMethod(ctx context.Context) string { func getMethod(ctx context.Context) string {
if v := ctx.Value(methodCtxKey); v != nil { if v := ctx.Value(methodCtxKey); v != nil {
if s, ok := v.(string); ok { if s, ok := v.(string); ok {