docs: various improvements (backport #1603) #1614
Merged
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
* docs: fix Query return parameters
* docs: fix the number of ABCI connections
ABCI creates 4 connections, not 3
* docs: bump cleveldb version
1.20 is 6 years old! 1.23 was released on Feb 24, 2021
* docs: remove check from PrepareProposal
This check only confuses readers. PrepareProposal returns
`proposal.Txs` (original list), not `txs`. Thus for loop is essentially
noop and can be removed. Even if we modify PrepareProposal to return
txs, it confuses application devs since CometBFT respects the limit when
creating a proposal! Therefore, application devs should only check the
limit when modifying the transactions, which is not the case here.
* docs: minor highlighting
* docs: fix syntax error
missing comma
* docs: fix gogoproto@v1.4.6/proto/merge.go:123:28: type error
go: go1.21.3 darwin/amd64
cometbft: v0.38.0
```
../../../go/pkg/mod/github.com/cosmos/gogoproto@v1.4.6/proto/merge.go:123:28:
type func(x *descriptorpb.FileDescriptorProto, y
*descriptorpb.FileDescriptorProto) bool of func(x, y
*descriptorpb.FileDescriptorProto) bool {…} does not match inferred type
func(a *descriptorpb.FileDescriptorProto, b
*descriptorpb.FileDescriptorProto) int for func(a E, b E) int
```
* docs: add missing double quote
* docs: make the same changes in go guide
- add a note about gogoproto
- simplify PrepareProposal
- add missing double quote
* docs: remove XXX
will create a separate PR updating gogoproto for v0.38
* Revert "docs: remove XXX"
This reverts commit a4a1a04.
(cherry picked from commit a05b73e)
# Conflicts:
# docs/guides/go-built-in.md
melekes
approved these changes
Nov 15, 2023
lasarojc
approved these changes
Nov 15, 2023
nivasan1
pushed a commit
to nivasan1/cometbft
that referenced
this pull request
Nov 28, 2023
* docs: various improvements (cometbft#1603) * docs: fix Query return parameters * docs: fix the number of ABCI connections ABCI creates 4 connections, not 3 * docs: bump cleveldb version 1.20 is 6 years old! 1.23 was released on Feb 24, 2021 * docs: remove check from PrepareProposal This check only confuses readers. PrepareProposal returns `proposal.Txs` (original list), not `txs`. Thus for loop is essentially noop and can be removed. Even if we modify PrepareProposal to return txs, it confuses application devs since CometBFT respects the limit when creating a proposal! Therefore, application devs should only check the limit when modifying the transactions, which is not the case here. * docs: minor highlighting * docs: fix syntax error missing comma * docs: fix gogoproto@v1.4.6/proto/merge.go:123:28: type error go: go1.21.3 darwin/amd64 cometbft: v0.38.0 ``` ../../../go/pkg/mod/github.com/cosmos/gogoproto@v1.4.6/proto/merge.go:123:28: type func(x *descriptorpb.FileDescriptorProto, y *descriptorpb.FileDescriptorProto) bool of func(x, y *descriptorpb.FileDescriptorProto) bool {…} does not match inferred type func(a *descriptorpb.FileDescriptorProto, b *descriptorpb.FileDescriptorProto) int for func(a E, b E) int ``` * docs: add missing double quote * docs: make the same changes in go guide - add a note about gogoproto - simplify PrepareProposal - add missing double quote * docs: remove XXX will create a separate PR updating gogoproto for v0.38 * Revert "docs: remove XXX" This reverts commit a4a1a04. (cherry picked from commit a05b73e) # Conflicts: # docs/guides/go-built-in.md * fix merge conflict --------- Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
3 tasks
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.
This is an automatic backport of pull request #1603 done by Mergify.
Cherry-pick of a05b73e has failed:
To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally
Mergify commands and options
More conditions and actions can be found in the documentation.
You can also trigger Mergify actions by commenting on this pull request:
@Mergifyio refreshwill re-evaluate the rules@Mergifyio rebasewill rebase this PR on its base branch@Mergifyio updatewill merge the base branch into this PR@Mergifyio backport <destination>will backport this PR on<destination>branchAdditionally, on Mergify dashboard you can:
Finally, you can contact us on https://mergify.com