Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the job timeout default to the godoc for Config.JobTimeout
Browse files Browse the repository at this point in the history
A very small change to add the job timeout default in words to the
godoc for `Config.JobTimeout` so that it's easily visible in
documentation, and so that a user doesn't have to go chasing around for
the value in code.

There is some nominal doc rot risk in case we change this number, but
probably it's worth it for added convenience. We're also living in that
world already because ~all of the other configuration properties
document their defaults.
brandur committed Nov 18, 2023
1 parent 3440549 commit 3e3ab0c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion client.go
Original file line number Diff line number Diff line change
@@ -39,7 +39,7 @@ const (
DefaultFetchPollInterval = 1 * time.Second
MinFetchPollInterval = 1 * time.Millisecond

DefaultJobTimeout = time.Minute
DefaultJobTimeout = 1 * time.Minute

DefaultMaxAttempts = rivercommon.DefaultMaxAttempts
DefaultQueue = rivercommon.DefaultQueue
@@ -106,6 +106,8 @@ type Config struct {
// context is cancelled. A timeout of zero means DefaultJobTimeout will be
// used, whereas a value of -1 means the job's context will not be cancelled
// unless the Client is shutting down.
//
// Defaults to 1 minute.
JobTimeout time.Duration

// Logger is the structured logger to use for logging purposes. If none is

0 comments on commit 3e3ab0c

Please sign in to comment.