Add missing doc for JobRow.UniqueStates + reveal rivertype.UniqueOptsByStateDefault()
#707
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
brandur
force-pushed
the
brandur-default-by-state
branch
from
f92b992 to
2db15aa
Compare
…ptsByStateDefault()` Two small ones related to unique job insertion: * Adding a missing doc comment on `JobRow.UniqueStates`. * As discussed in #704, reveal a way for end users to get the default set of unique job states via `rivertype.UniqueOptsByStateDefault()`. Similar to `rivertype.JobStates()`, this is revealed as a function so that it's not possible to accidentally mutate a global slice. (Go: readonly variables would sure be pretty nice.)
brandur
force-pushed
the
brandur-default-by-state
branch
from
2db15aa to
8120584
Compare
brandur
commented
Dec 27, 2024
| // UniqueOpts.ByState. So for example, with this default set a new unique job | ||
| // may be inserted even if another job already exists, as long as that other job | ||
| // is set `cancelled` or `discarded`. | ||
| func UniqueOptsByStateDefault() []JobState { |
There was a problem hiding this comment.
Naming on this one seems a little awkward, but I think it might be the best way to go: it's basically UniqueOpts + ByState + Default so it copies the taxonomy of the field it's being set to.
bgentry
approved these changes
Dec 27, 2024
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.
Two small ones related to unique job insertion:
Adding a missing doc comment on
JobRow.UniqueStates.As discussed in Correct Way to Enforce Uniqueness on Insertion By Kind and Default States #704, reveal a way for end users to get the default
set of unique job states via
rivertype.UniqueOptsByStateDefault().Similar to
rivertype.JobStates(), this is revealed as a function sothat it's not possible to accidentally mutate a global slice. (Go:
readonly variables would sure be pretty nice.)