Update comments to distinguish between operations and state-storage backends more clearly #37085
+7
−7
Conversation
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
…ackends more clearly
SarahFrench
added
the
no-changelog-needed
SarahFrench
commented
May 19, 2025
|
|
||
| if !opts.ForceLocal { | ||
| log.Printf("[TRACE] Meta.Backend: backend %T does not support operations, so wrapping it in a local backend", b) | ||
| } | ||
|
|
||
| // Build the local backend | ||
| // Build the local operations backend |
There was a problem hiding this comment.
Question for reviewer- I wanted to include this comment but wasn't sure if it added context that couldn't already be learned from the code. Does this comment help with understanding, or does it add clutter?
Suggested change
| // Build the local operations backend | |
| // Build the local operations backend | |
| // Note: If b is nil then we are using implicit local state storage. |
SarahFrench
commented
May 19, 2025
| // BackendOpts are the options used to initialize a backend.Backend. | ||
| // BackendOpts are the options used to initialize a backendrun.OperationsBackend. |
There was a problem hiding this comment.
Similar prompt for reviewer - this change might be debatable.
From my perspective, this struct is used both in logic specific to initialising backendrun.OperationsBackends and backend.Backends, but overall the use of these options is to affect the returned operations backend.
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.
Target Release
N/A
Rollback Plan
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
None.
CHANGELOG entry