[go] context: fix package doc description of WithDeadlineCause and WithTimeoutCause

0 views

Skip to first unread message

Gopher Robot (Gerrit)

unread,

Mar 17, 2026, 2:55:40 PM (yesterday) Mar 17

to Yongqi Jia, goph...@pubsubhelper.golang.org, golang-...@googlegroups.com, Mark Freeman, Carlos Amedee, Go LUCI, Ian Lance Taylor, golang-co...@googlegroups.com

Gopher Robot submitted the change

Change information

Commit message:

context: fix package doc description of WithDeadlineCause and WithTimeoutCause

The package documentation incorrectly states that WithCancelCause,
WithDeadlineCause, and WithTimeoutCause all return a CancelCauseFunc.
In fact, only WithCancelCause returns a CancelCauseFunc. WithDeadlineCause
and WithTimeoutCause accept a cause error parameter directly and return
a plain CancelFunc.

Update the documentation to accurately describe the difference.

Fixes #77478

Change-Id: I581f8a954dd98567bc46e74ded62af927cc48fb2

Reviewed-on: https://go-review.googlesource.com/c/go/+/750824

Reviewed-by: Sean Liao <se...@liao.dev>

Auto-Submit: Sean Liao <se...@liao.dev>

Reviewed-by: Mark Freeman <markf...@google.com>

Reviewed-by: Carlos Amedee <car...@golang.org>

LUCI-TryBot-Result: Go LUCI <golang...@luci-project-accounts.iam.gserviceaccount.com>

Reviewed-by: Ian Lance Taylor <ia...@golang.org>

Files:

M src/context/context.go

Change size: S

Delta: 1 file changed, 6 insertions(+), 5 deletions(-)

Branch: refs/heads/master

Submit Requirements:

Code-Review: +1 by Mark Freeman, +2 by Ian Lance Taylor, +1 by Sean Liao, +1 by Carlos Amedee
TryBots-Pass: LUCI-TryBot-Result+1 by Go LUCI

Open in Gerrit

Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings.

Gerrit

open

diffy

satisfied_requirement

Reply all

Reply to author

Forward

0 new messages