qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-17 04:14:52 -07:00
Code Releases Activity

context: update doc comment to link to context interface

Browse Source 
Linking to the Context interface in the WithCancel doc comment makes
it more consistent with the WithDeadline and WithTimeout doc comments.
This commit is contained in:
ALX99 2024-02-17 13:29:43 +09:00
parent e41fabd688
commit 9c6bb607a9
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/context/context.go
View File

@ -231,7 +231,7 @@ type CancelFunc func()
// or when the parent context's Done channel is closed, whichever happens first. // or when the parent context's Done channel is closed, whichever happens first.
// //
// Canceling this context releases resources associated with it, so code should // Canceling this context releases resources associated with it, so code should
// call cancel as soon as the operations running in this Context complete. // call cancel as soon as the operations running in this [Context] complete.
func WithCancel(parent Context) (ctx Context, cancel CancelFunc) { func WithCancel(parent Context) (ctx Context, cancel CancelFunc) {
c := withCancel(parent) c := withCancel(parent)
return c, func() { c.cancel(true, Canceled, nil) } return c, func() { c.cancel(true, Canceled, nil) }