Feat(core): Improve documentation for block module #107
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
alexanderwiederin
force-pushed
the
docs-block
branch
from
249a5fb to
aa2c2ab
Compare
sedited
reviewed
Nov 10, 2025
src/core/block.rs
Outdated
| //! | ||
| //! This module provides types for working with blocks, block hashes, spent | ||
| //! outputs (undo data), coins, and transaction spent outputs. All types except | ||
| //! blocks include both owned and borrowed variants for efficient memory management. |
Owner
There was a problem hiding this comment.
I would drop this last sentence. It's easy for it to go out of date, and I don't think it adds much.
Contributor
Author
There was a problem hiding this comment.
Done! Also to the part a few lines down.
src/core/block.rs
Outdated
| /// | ||
| /// # Structure | ||
| /// | ||
| /// The spent outputs are organized by transaction (excluding the coinbase, which |
Owner
There was a problem hiding this comment.
I would re-word this as: "The spent outputs are ordered by transaction order in a block"
src/core/block.rs
Outdated
| /// | ||
| /// This iterator yields [`TransactionSpentOutputsRef`] items for each transaction | ||
| /// in the block that has spent outputs (excluding the coinbase transaction, which | ||
| /// has no inputs). |
Owner
There was a problem hiding this comment.
I don't think it is correct to say that is has no inputs. It has a coinbase input, but it doesn't a prevout.
Contributor
Author
There was a problem hiding this comment.
Removed unnecessary detail and just mention "excluding the coinbase transaction" now.
alexanderwiederin
force-pushed
the
docs-block
branch
2 times, most recently
from
5dab9e8 to
dc03084
Compare
alexanderwiederin
force-pushed
the
docs-block
branch
from
dc03084 to
0ba8908
Compare
Contributor
Author
sedited
approved these changes
Nov 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.