Additional docs for JobArgs.Kind#892
Merged
Merged
Conversation
Follow up #879 to add a little more useful context to `JobArgs.Kind`: * Explain why `Kind` is a string rather than based on type names. * Mention that special characters like spaces and commas are not allowed. Suggest examples on what _is_ allowed. * Mention how changing a kind generally isn't safe unless the database is completely empty and that `JobArgsWithKindAliases` can be used to rename jobs safely.
Contributor
Author
|
ty ty. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Follow up #879 to add a little more useful context to
JobArgs.Kind:Kindis a string rather than based on type names.allowed. Suggest examples on what is allowed.
is completely empty and that
JobArgsWithKindAliasescan be used torename jobs safely.