docs(cometbft): update ABCI and data structure links#117
Open
docs(cometbft): update ABCI and data structure links#117
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation links and embeds external markdown documentation into various modules to align with the new CometBFT docs.
- Updated outdated Tendermint and old CometBFT links to new URLs under the v1.0 spec.
- Replaced inline documentation with external markdown includes in selected ABCI request files.
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| cometbft/src/vote.rs | Updated the vote data structure documentation link. |
| cometbft/src/consensus/params.rs | Updated the ABCI documentation link reference for consensus parameters. |
| cometbft/src/block/id.rs | Updated the block ID documentation link. |
| cometbft/src/block/header.rs | Updated the header documentation link. |
| cometbft/src/block/commit.rs | Removed outdated TODO links and updated the commit documentation link. |
| cometbft/src/block.rs | Updated the block structure documentation link. |
| cometbft/src/abci/types.rs | Removed the outdated ABCI documentation comment. |
| cometbft/src/abci/response/finalize_block.rs | Introduced external markdown documentation for finalizing blocks. |
| cometbft/src/abci/request/init_chain.rs | Replaced inline documentation with external markdown; a stray '#' line is present. |
| cometbft/src/abci/request/apply_snapshot_chunk.rs | Introduced external markdown documentation via include_str!. |
| cometbft/src/abci/request.rs | Cleared repeated comment blocks for cleaner documentation. |
| cometbft/src/abci/event.rs | Updated the events documentation link to the new URL. |
| cometbft/src/abci/code.rs | Updated the error-returning documentation link to the new URL. |
| cometbft/src/abci.rs | Updated the ABCI module documentation link to the new URL with updated methods. |
Comments suppressed due to low confidence (1)
cometbft/src/abci/request/init_chain.rs:5
- The line containing only '#' appears to be extraneous. Consider removing it to ensure the documentation is formatted correctly.
#
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
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.
No description provided.