Skip to content

Commit

Permalink
fix(docs): fix GetVerifiedRange doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vgonkivs committed Oct 9, 2023
1 parent 49d962e commit adf874a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/adr/adr-009-public-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ GetByHeight(ctx context.Context, height uint64) (*header.ExtendedHeader, error)
// WaitForHeight blocks until the header at the given height has been processed
// by the node's header store or until context deadline is exceeded.
WaitForHeight(ctx context.Context, height uint64) (*header.ExtendedHeader, error)
// GetVerifiedRangeByHeight returns the given range [from:to) of ExtendedHeaders
// GetVerifiedRangeByHeight returns the given range (from:to) of ExtendedHeaders
// from the node's header store and verifies that the returned headers are
// adjacent to each other.
GetVerifiedRangeByHeight(ctx context.Context, from, to uint64) ([]*ExtendedHeader, error)
Expand Down
2 changes: 1 addition & 1 deletion nodebuilder/header/header.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type Module interface {

// GetByHash returns the header of the given hash from the node's header store.
GetByHash(ctx context.Context, hash libhead.Hash) (*header.ExtendedHeader, error)
// GetVerifiedRangeByHeight returns the given range [from:to) of ExtendedHeaders
// GetVerifiedRangeByHeight returns the given range (from:to) of ExtendedHeaders
// from the node's header store and verifies that the returned headers are
// adjacent to each other.
GetVerifiedRangeByHeight(
Expand Down

0 comments on commit adf874a

Please sign in to comment.