CLOUDP-355972: Even more CRD comment updates #2981
Merged
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
josvazg
approved these changes
Dec 4, 2025
api/v1/status/global_deployment.go
Outdated
Comment on lines
40
to
41
| // Flag that indicates whether someone hashed the custom shard key. If this parameter returns false, this cluster uses ranged sharding. | ||
| IsShardKeyUnique *bool `json:"isShardKeyUnique,omitempty"` // Flag that specifies whether the underlying index enforces a unique constraint. |
Collaborator
There was a problem hiding this comment.
q: Does this use the comment at the top or on the side?
I would probably leave just one of them.
Collaborator
Author
There was a problem hiding this comment.
It seems to ignore the inline/side comments, and just uses the ones above. I've removed the inline ones here, because it was just duplicating the information, but it's good to know that we can still use inline for dev-targeted comments.
s-urbaniak
approved these changes
Dec 4, 2025
roothorp
force-pushed
the
cloudp-355972-more-crd-comments
branch
from
a39c339 to
81a9885
Compare
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.
Summary
Fixes some missing or incomplete CRD comments, mainly surrounding status. This seems to give us ~100% comment coverage on CRD fields, so the docs should be complete after this.
Proof of Work
Checklist
Reminder (Please remove this when merging)