trie: fix a typo, use correct docstrings (#28302)

* fix a typo

* trie: additional fixes to docstrings

---------

Co-authored-by: Martin Holst Swende <martin@swende.se>
pull/28305/head
Brandon Liu 1 year ago committed by GitHub
parent 6b1e4f4211
commit 6505297456
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      trie/sync.go

@ -302,7 +302,7 @@ func (s *Sync) Missing(max int) ([]string, []common.Hash, []common.Hash) {
} }
// ProcessCode injects the received data for requested item. Note it can // ProcessCode injects the received data for requested item. Note it can
// happpen that the single response commits two pending requests(e.g. // happen that the single response commits two pending requests(e.g.
// there are two requests one for code and one for node but the hash // there are two requests one for code and one for node but the hash
// is same). In this case the second response for the same hash will // is same). In this case the second response for the same hash will
// be treated as "non-requested" item or "already-processed" item but // be treated as "non-requested" item or "already-processed" item but
@ -391,7 +391,7 @@ func (s *Sync) Pending() int {
return len(s.nodeReqs) + len(s.codeReqs) return len(s.nodeReqs) + len(s.codeReqs)
} }
// schedule inserts a new state retrieval request into the fetch queue. If there // scheduleNodeRequest inserts a new state retrieval request into the fetch queue. If there
// is already a pending request for this node, the new request will be discarded // is already a pending request for this node, the new request will be discarded
// and only a parent reference added to the old one. // and only a parent reference added to the old one.
func (s *Sync) scheduleNodeRequest(req *nodeRequest) { func (s *Sync) scheduleNodeRequest(req *nodeRequest) {
@ -406,7 +406,7 @@ func (s *Sync) scheduleNodeRequest(req *nodeRequest) {
s.queue.Push(string(req.path), prio) s.queue.Push(string(req.path), prio)
} }
// schedule inserts a new state retrieval request into the fetch queue. If there // scheduleCodeRequest inserts a new state retrieval request into the fetch queue. If there
// is already a pending request for this node, the new request will be discarded // is already a pending request for this node, the new request will be discarded
// and only a parent reference added to the old one. // and only a parent reference added to the old one.
func (s *Sync) scheduleCodeRequest(req *codeRequest) { func (s *Sync) scheduleCodeRequest(req *codeRequest) {
@ -556,7 +556,7 @@ func (s *Sync) children(req *nodeRequest, object node) ([]*nodeRequest, error) {
return requests, nil return requests, nil
} }
// commit finalizes a retrieval request and stores it into the membatch. If any // commitNodeRequest finalizes a retrieval request and stores it into the membatch. If any
// of the referencing parent requests complete due to this commit, they are also // of the referencing parent requests complete due to this commit, they are also
// committed themselves. // committed themselves.
func (s *Sync) commitNodeRequest(req *nodeRequest) error { func (s *Sync) commitNodeRequest(req *nodeRequest) error {
@ -591,7 +591,7 @@ func (s *Sync) commitNodeRequest(req *nodeRequest) error {
return nil return nil
} }
// commit finalizes a retrieval request and stores it into the membatch. If any // commitCodeRequest finalizes a retrieval request and stores it into the membatch. If any
// of the referencing parent requests complete due to this commit, they are also // of the referencing parent requests complete due to this commit, they are also
// committed themselves. // committed themselves.
func (s *Sync) commitCodeRequest(req *codeRequest) error { func (s *Sync) commitCodeRequest(req *codeRequest) error {

Loading…
Cancel
Save