doc: split magic numbers #139
Merged
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
In dramatiq, `DEFAULT_RESULT_TTL = 600_000` which is documented as the 10 minute default. In django_dramatiq, the example uses `"result_ttl": 60_000` which equates to 1 minute. Although the example shows a customization and not necessarily the defaults, the duration is better communicated by splitting it up into different units. Maybe it's just me, but I wasn't sure which units the durations had to be specified in and had to look at the source code / docs.
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.
In dramatiq,
DEFAULT_RESULT_TTL = 600_000which is documented as the 10 minute default. In django_dramatiq, the example uses"result_ttl": 60_000which equates to 1 minute. Although the example shows a customization and not necessarily the defaults, the duration is better communicated by splitting it up into different units.Maybe it's just me, but I wasn't sure which units the durations had to be specified in and had to look at the source code / docs.