Add message documentation for GitCommitInformation #2458
Merged
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
bufdev
reviewed
Sep 19, 2023
| @@ -28,6 +28,9 @@ message GitIdentity { | |||
| google.protobuf.Timestamp time = 3; | |||
| } | |||
|
|
|||
| // GitCommitInformation is the information associated with a Git commit. | |||
| // This always includes the hash. | |||
| // The author and/or committer user identities are included when available. | |||
There was a problem hiding this comment.
Unrelated, but why are author and committer marked optional? Messages have presence by default.
There was a problem hiding this comment.
Yeah, there was feedback from a different proto a while back to make this explicit, despite the fact that it's already the default. That being said, I think between the message and field documentation, it should be clear, I'll remove the optional.
bufdev
approved these changes
Sep 21, 2023
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 documentation to the
GitCommitInformationmessage.