Add the job timeout default to the godoc for Config.JobTimeout
#33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
force-pushed
the
brandur-job-timeout-default
branch
from
3e52d84 to
3e3ab0c
Compare
bgentry
approved these changes
Nov 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A very small change to add the job timeout default in words to the
godoc for
Config.JobTimeoutso that it's easily visible indocumentation, 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.