From a2cf93d1b9096254d92148ab33e6da9d8b621160 Mon Sep 17 00:00:00 2001 From: Viacheslav Date: Mon, 9 Oct 2023 17:24:27 +0300 Subject: [PATCH] fix(docs): fix GetVerifiedRange doc (#2826) --- docs/adr/adr-009-public-api.md | 2 +- nodebuilder/header/header.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/adr/adr-009-public-api.md b/docs/adr/adr-009-public-api.md index 76bb1c5ab9..d2bf6ee817 100644 --- a/docs/adr/adr-009-public-api.md +++ b/docs/adr/adr-009-public-api.md @@ -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) diff --git a/nodebuilder/header/header.go b/nodebuilder/header/header.go index d7eb7b5b46..9b9455da26 100644 --- a/nodebuilder/header/header.go +++ b/nodebuilder/header/header.go @@ -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(