Skip to content

Commit a1268f7

Browse files
authored
Typo fix Update adr-002-ipld-da-sampling.md (#1535)
## Description Fix Typographical Errors in Function Descriptions This pull request addresses and fixes critical typographical errors in the descriptions of several functions that affect code clarity and correctness. #### Fixed Issues: 1. **Typo in "contex.Context"**: - In the descriptions of the following functions: `ValidateAvailability`, `RetrieveBlockData`, and `PutBlock`, the reference to **"contex.Context"** has been corrected to **"context.Context"**. - **Importance**: This correction is crucial as the incorrect spelling could lead to confusion or misinterpretation of the intended type, especially for developers referencing or using these functions. Proper naming ensures clarity, adherence to Go standards, and minimizes potential errors or misunderstandings in documentation and code navigation. #### PR checklist - [x] Tests written/updated - [ ] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments --- **Please review and consider merging this fix. Thank you!**
1 parent fcfaf92 commit a1268f7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/celestia-architecture/adr-002-ipld-da-sampling.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ It does not deal with IPFS internals.
143143
// The context can be used to provide a timeout.
144144
// TODO: Should there be a constant = lower bound for #samples
145145
func ValidateAvailability(
146-
ctx contex.Context,
146+
ctx context.Context,
147147
dah *DataAvailabilityHeader,
148148
numSamples int,
149149
onLeafValidity func(namespace.PrefixedData8),
@@ -154,7 +154,7 @@ func ValidateAvailability(
154154
// The key difference is that it will sample enough chunks until it can recover the
155155
// full extended data square, including original data (e.g. by using rsmt2d.RepairExtendedDataSquare).
156156
func RetrieveBlockData(
157-
ctx contex.Context,
157+
ctx context.Context,
158158
dah *DataAvailabilityHeader,
159159
api coreiface.CoreAPI,
160160
codec rsmt2d.Codec,
@@ -166,7 +166,7 @@ func RetrieveBlockData(
166166
// the row to the Merkle Dag, in our case a Namespaced Merkle Tree.
167167
// Note, that this method could also fill the DA header.
168168
// The data will be pinned by default.
169-
func (b *Block) PutBlock(ctx contex.Context, nodeAdder ipld.NodeAdder) error
169+
func (b *Block) PutBlock(ctx context.Context, nodeAdder ipld.NodeAdder) error
170170
```
171171

172172
We now describe the lower-level library that will be used by above methods.

0 commit comments

Comments
 (0)