fix the comment of FinalityAware::GetFinalizedHeader

siburu · siburu · commit 3f2a150b1f4c · 2023-11-10T20:30:46.000+09:00
Signed-off-by: Masanori Yoshida &lt;masanori.yoshida@datachain.jp&gt;
diff --git a/core/provers.go b/core/provers.go
@@ -49,7 +49,7 @@ type LightClient interface {
 // FinalityAware provides the capability to determine the finality of the chain
 type FinalityAware interface {
 	// GetFinalizedHeader returns the finalized header on this chain corresponding to `height`.
-	// If `height` is nil, this function returns the latest finalized header.
+	// If `height` is zero, this function returns the latest finalized header.
 	// If the header at `height` isn't finalized yet, this function returns an error.
 	GetFinalizedHeader(height uint64) (Header, error)
 }

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ type LightClient interface {`
`49`	`49`	`// FinalityAware provides the capability to determine the finality of the chain`
`50`	`50`	`type FinalityAware interface {`
`51`	`51`	// GetFinalizedHeader returns the finalized header on this chain corresponding to `height`.
`52`		- // If `height` is nil, this function returns the latest finalized header.
	`52`	+ // If `height` is zero, this function returns the latest finalized header.
`53`	`53`	// If the header at `height` isn't finalized yet, this function returns an error.
`54`	`54`	`GetFinalizedHeader(height uint64) (Header, error)`
`55`	`55`	`}`