Open
Conversation
vknabel
reviewed
Mar 27, 2026
vknabel
reviewed
Mar 27, 2026
Comment on lines
-11
to
12
| // Get an audit trace | ||
| // Returns the audit trace with the specified UUID. | ||
| rpc Get(AuditServiceGetRequest) returns (AuditServiceGetResponse) { |
Contributor
There was a problem hiding this comment.
Reads good, but do we want the Get rpc name to be the first word in doc strings as before?
Regarding Go doc strings. In that case something like Get returns an audit trace
vknabel
reviewed
Mar 27, 2026
| import "metalstack/api/v2/predefined_rules.proto"; | ||
|
|
||
| // SizeService serves size related functions | ||
| // SizeService provides size management operations. |
Contributor
There was a problem hiding this comment.
Just picking this as an example. It seems like the AI:
- added trailing
.forserviceandrpcdeclarations - removed tailing
.for fields
Is this intentional and the new convention?
Contributor
Author
There was a problem hiding this comment.
This is part of the bufbuild best practices, we should somewhere document this, but dunno where developers can easily spot this type of documentation
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.
Description
Enhance documentation to be better english and correct punctuation.
Also added validation to partition.management_server_addresses (with my brain)
Used AI-Tools ✨