Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: improve request prepare proposal comments #1393

Merged
merged 3 commits into from
Jun 18, 2024
Merged

chore: improve request prepare proposal comments #1393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cb1e78
chore: improve request prepare proposal comments
rootulp Jun 13, 2024
7e97bb0
revert: newline changes
rootulp Jun 13, 2024
3526606
Merge branch 'v0.34.x-celestia' into rp/improve-comments-request-prep…
rootulp Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions abci/types/types.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions proto/tendermint/abci/types.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ message RequestApplySnapshotChunk {
}

message RequestPrepareProposal {
// block_data is an array of transactions that will be included in a block,
// sent to the app for possible modifications.
// applications can not exceed the size of the data passed to it.
// BlockData is a slice of candidate transactions that may be included in a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit]

Suggested change
// BlockData is a slice of candidate transactions that may be included in a
// block_data is a slice of candidate transactions that may be included in a

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather use BlockData because IMO more people are likely to read the generated Go comments instead of the raw protobuf comments.

Screenshot 2024-06-17 at 10 09 07 AM

// block. BlockData is sent to the application so that the application can
// filter and re-arrange the slice of candidate transactions.
tendermint.types.Data block_data = 1;
// If an application decides to populate block_data with extra information, they can not exceed this value.
// BlockDataSize is the maximum size (in bytes) that BlockData should be.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit]

Suggested change
// BlockDataSize is the maximum size (in bytes) that BlockData should be.
// block_data_size is the maximum size (in bytes) that BlockData should be.

int64 block_data_size = 2;
// chain_id is a unique identifier for the blockchain network this proposal
// belongs to (e.g. mocha-1).
Expand Down
Loading