Skip to content

Commit 86b01ad

Browse files
authored
chore: improve code comments clarity (#2947)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/ --> ## Overview <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. Ex: Closes #<issue number> --> improve code comments clarity Signed-off-by: luohewuyang <luohewuyang@outlook.com>
1 parent 03e6d19 commit 86b01ad

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

block/internal/submitting/submitter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ func (s *Submitter) processDAInclusionLoop() {
264264
}
265265

266266
// setFinalWithRetry sets the final height in executor with retry logic.
267-
// NOTE: the function retries the execution client call regardless of the error. Some execution clients errors are irrecoverable, and will eventually halt the node, as expected.
267+
// NOTE: the function retries the execution client call regardless of the error. Some execution client errors are irrecoverable, and will eventually halt the node, as expected.
268268
func (s *Submitter) setFinalWithRetry(nextHeight uint64) error {
269269
for attempt := 1; attempt <= common.MaxRetriesBeforeHalt; attempt++ {
270270
if err := s.exec.SetFinal(s.ctx, nextHeight); err != nil {

types/signed_header.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ func (sh *SignedHeader) ValidateBasic() error {
185185
return ErrSignatureVerificationFailed
186186
}
187187

188-
// ValidateBasicWithData performs basic validator of a signed header, granted data for syncing node.
188+
// ValidateBasicWithData performs basic validation of a signed header, given data for syncing node.
189189
func (sh *SignedHeader) ValidateBasicWithData(data *Data) error {
190190
if err := sh.Header.ValidateBasic(); err != nil {
191191
return err

0 commit comments

Comments
 (0)