Skip to content

Commit

Permalink
docs: fix typos (#252)
Browse files Browse the repository at this point in the history
## Overview
This PR fixes some typos or grammatical mistakes!

## Checklist

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

Documentation:
- Corrected a typo in the comments of the `Blobstream` contract,
improving readability.
- Clarified the structure of the Merkle tree in the comments, enhancing
understanding of the data structure.

Please note that these changes are purely documentation updates and do
not affect the functionality of the system.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
0xScratch authored Nov 2, 2023
1 parent 9dade12 commit 856a9e5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions src/Blobstream.sol
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ struct Signature {
/// (see ./DataRootTuple.sol), with each tuple representing a single data root
/// in a Celestia block header. Relayed tuples are in the same order as the
/// block headers.
/// @dev DO NOT REMOVE INHERITENCE OF THE FOLLOWING CONTRACTS: Initializable, UUPSUpgradeable and
/// @dev DO NOT REMOVE INHERITANCE OF THE FOLLOWING CONTRACTS: Initializable, UUPSUpgradeable and
/// OwnableUpgradeable! They're essential for upgradability.
contract Blobstream is IDAOracle, Initializable, UUPSUpgradeable, OwnableUpgradeable {
// Don't change the order of state for working upgrades AND BE AWARE OF
Expand Down Expand Up @@ -292,7 +292,7 @@ contract Blobstream is IDAOracle, Initializable, UUPSUpgradeable, OwnableUpgrade
///
/// The data root root is the Merkle root of the binary Merkle tree
/// (https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#binary-merkle-tree)
/// where each leaf in an ABI-encoded `DataRootTuple`. Each relayed data
/// where each leaf is in an ABI-encoded `DataRootTuple`. Each relayed data
/// root tuple will 1:1 mirror data roots as they are included in headers
/// on Celestia, _in order of inclusion_.
///
Expand Down
Loading

0 comments on commit 856a9e5

Please sign in to comment.