trie: additional fixes to docstrings

This commit is contained in:
Martin Holst Swende 2023-10-10 10:14:02 +02:00
parent c4c702ee35
commit 2daf47c149
No known key found for this signature in database
GPG key ID: 683B438C05A5DDF0

View file

@ -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 {