api: add documentation comments to exported fields #81
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
Adds missing documentation comments to exported fields in the v1alpha1 API to comply with Go style guidelines requiring all exported identifiers to be documented. Updates: - Shard: ShardSpec, ShardStatus, and ShardImages. - TableGroup: TableGroupSpec, ShardResolvedSpec, and TableGroupStatus. - Cell: CellStatus and TopologyReconciliation. - TopoServer: GlobalTopoServerRef.
rytswd
approved these changes
Dec 18, 2025
Member
rytswd
left a comment
rytswd
left a comment
There was a problem hiding this comment.
Love we are so cautious about the documentation already 🥰
LGTM!
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.
Adds missing documentation comments to exported fields in the v1alpha1 API to comply with Go style guidelines requiring all exported identifiers to be documented.
Updates: