mirror of https://github.com/golang/go.git
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.
This commit is contained in:
parent
eb6f2c24cd
commit
4b039fba90
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue