proto: fix proto-linter comments for epoching/zoneconcierge #331
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
vitsalis
approved these changes
Mar 21, 2023
| // CheckpointAddresses contains the addresses of the submitter and reporter of a | ||
| // given checkpoint submitter is the address of the submitter of the checkpoint | ||
| // to BTC reporter is the address of the submitter of the MsgInsertBTCSpvProof | ||
| // message to Babylon |
There was a problem hiding this comment.
The formatting for this comment seems off. e.g., submitter is the address of the submitter should have a period before it or be on a new line.
| @@ -5,10 +5,13 @@ import "gogoproto/gogo.proto"; | |||
|
|
|||
| option go_package = "github.com/babylonchain/babylon/x/epoching/types"; | |||
|
|
|||
| // EventBeginEpoch is the event that an epoch has started | |||
There was a problem hiding this comment.
Suggested change
| // EventBeginEpoch is the event that an epoch has started | |
| // EventBeginEpoch is an event emitted when an epoch has started |
| message EventBeginEpoch { uint64 epoch_number = 1; } | ||
|
|
||
| // EventEndEpoch is the event that an epoch has ended |
There was a problem hiding this comment.
Suggested change
| // EventEndEpoch is the event that an epoch has ended | |
| // EventEndEpoch is an event emitted when an epoch has ended |
There was a problem hiding this comment.
Overall, the same for the following comments, i.e. use is an event emitted instead of is the event. Think it better corresponds with the event nature here
proto/babylon/epoching/v1/tx.proto
Outdated
| @@ -23,26 +23,38 @@ service Msg { | |||
| returns (MsgWrappedBeginRedelegateResponse); | |||
| } | |||
|
|
|||
| // MsgWrappedDelegate is the message for delegating some stakes | |||
There was a problem hiding this comment.
Suggested change
| // MsgWrappedDelegate is the message for delegating some stakes | |
| // MsgWrappedDelegate is the message for delegating stake |
proto/babylon/epoching/v1/tx.proto
Outdated
| message MsgWrappedDelegateResponse {} | ||
|
|
||
| // MsgWrappedUndelegate is the message for undelegating some stakes |
There was a problem hiding this comment.
Suggested change
| // MsgWrappedUndelegate is the message for undelegating some stakes | |
| // MsgWrappedUndelegate is the message for undelegating stake |
proto/babylon/epoching/v1/tx.proto
Outdated
| message MsgWrappedUndelegateResponse {} | ||
|
|
||
| // MsgWrappedDelegate is the message for moving some bonded stakes from a |
There was a problem hiding this comment.
Suggested change
| // MsgWrappedDelegate is the message for moving some bonded stakes from a | |
| // MsgWrappedDelegate is the message for moving bonded stake from a |
proto/buf.yaml
Outdated
| @@ -13,6 +13,12 @@ lint: | |||
| - DEFAULT | |||
| - COMMENTS | |||
| - FILE_LOWER_SNAKE_CASE | |||
| # TODO Decide which comments we would like to enfore by linter | |||
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.
Fixes BM-566
This PR fixes proto-linter in terms of the comments. It also updates the
buf.yamlto enforce linting rules, executesmake proto-formatto format all proto files, and executesmake proto-allto update all compiled stuff.