From 4b039fba90f385a6ca8e44e8a34fbc339dbc21f0 Mon Sep 17 00:00:00 2001 From: "Matt T. Proud" Date: Sat, 28 Sep 2024 15:27:25 +0200 Subject: [PATCH] context: link to context and structs blog post This commit amends the package documentation for the context package and links the https://go.dev/blog/context-and-structs where the package documentation dissuades one against embedding a context into a struct. This is to help close the gap in understanding why this otherwise cryptic piece of guidance is provided. The other referenced blog article now points to go.dev instead of golang.org. --- src/context/context.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/context/context.go b/src/context/context.go index c960fda5f1..db8bc69553 100644 --- a/src/context/context.go +++ b/src/context/context.go @@ -33,7 +33,8 @@ // propagation: // // Do not store Contexts inside a struct type; instead, pass a Context -// explicitly to each function that needs it. The Context should be the first +// explicitly to each function that needs it. This is discussed further in +// https://go.dev/blog/context-and-structs. The Context should be the first // parameter, typically named ctx: // // func DoSomething(ctx context.Context, arg Arg) error { @@ -49,7 +50,7 @@ // The same Context may be passed to functions running in different goroutines; // Contexts are safe for simultaneous use by multiple goroutines. // -// See https://blog.golang.org/context for example code for a server that uses +// See https://go.dev/blog/context for example code for a server that uses // Contexts. package context