@@ -52,7 +52,7 @@ When generating documentation for functions that read data, carefully differenti
5252As an example for functions of type (i), consider ` operation.RetrieveSeal ` :
5353``` golang
5454// RetrieveSeal retrieves [flow.Seal] by its ID.
55- // Expected errors during normal operations:
55+ // Expected error returns during normal operations:
5656// - [storage.ErrNotFound] if no seal with the specified `sealID` is known.
5757func RetrieveSeal (r storage .Reader , sealID flow .Identifier , seal *flow .Seal ) error
5858```
@@ -67,7 +67,7 @@ As an example for functions of type (ii), consider `operation.LookupPayloadSeals
6767```golang
6868// LookupPayloadSeals retrieves the list of Seals that were included in the payload
6969// of the specified block. For every known block, this index should be populated (at or above the root block).
70- // Expected errors during normal operations:
70+ // Expected error returns during normal operations:
7171// - [storage.ErrNotFound] if `blockID` does not refer to a known block
7272func LookupPayloadSeals(r storage.Reader, blockID flow.Identifier, sealIDs *[]flow.Identifier) error error
7373```
@@ -93,7 +93,7 @@ As an example for functions of type (i.a), consider `operation.UpsertCollection`
9393// from the value (collection) via a collision-resistant hash function. Hence, unchecked overwrites pose no risk
9494// of data corruption, because for the same key, we expect the same value.
9595//
96- // No other error returns are expected during normal operation.
96+ // No error returns are expected during normal operation.
9797func UpsertCollection(w storage.Writer, collection *flow.LightCollection) error {
9898 return UpsertByKey (w, MakePrefix (codeCollection, collection.ID ()), collection)
9999}
@@ -117,7 +117,7 @@ As an example for functions of type (i.b), consider `operation.InsertSeal`:
117117// This method silently overrides existing data, which is safe only if for the same key, we
118118// always write the same value.
119119//
120- // No other error returns are expected during normal operation.
120+ // No error returns are expected during normal operation.
121121func InsertSeal (w storage .Writer , sealID flow .Identifier , seal *flow .Seal ) error {
122122 return UpsertByKey (w, MakePrefix (codeSeal, sealID), seal)
123123}
@@ -182,7 +182,7 @@ As an example for functions of type (i.b), consider `operation.IndexPayloadSeals
182182// serves as a reminder that the CALLER is responsible to ensure that the DEDUPLICATION CHECK is done elsewhere
183183// ATOMICALLY with this write operation.
184184//
185- // No other error returns are expected during normal operation.
185+ // No error returns are expected during normal operation.
186186func IndexPayloadSeals (lctx lockctx.Proof , w storage.Writer , blockID flow.Identifier , sealIDs []flow.Identifier ) error {
187187 if !lctx.HoldsLock (storage.LockInsertBlock ) {
188188 return fmt.Errorf (" cannot index seal for blockID %v without holding lock %s " ,
0 commit comments