all: fix function names in docs (#29128)

Signed-off-by: cui fliter <imcusg@gmail.com>
This commit is contained in:
cui fliter 2024-02-29 17:29:06 +08:00 committed by GitHub
parent 1883438964
commit dbc27a199f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 8 additions and 8 deletions

View File

@ -100,7 +100,7 @@ func (ps *peerSet) registerSnapExtension(peer *snap.Peer) error {
return nil return nil
} }
// waitExtensions blocks until all satellite protocols are connected and tracked // waitSnapExtension blocks until all satellite protocols are connected and tracked
// by the peerset. // by the peerset.
func (ps *peerSet) waitSnapExtension(peer *eth.Peer) (*snap.Peer, error) { func (ps *peerSet) waitSnapExtension(peer *eth.Peer) (*snap.Peer, error) {
// If the peer does not support a compatible `snap`, don't wait // If the peer does not support a compatible `snap`, don't wait

View File

@ -136,7 +136,7 @@ func (p *Peer) dispatchRequest(req *Request) error {
} }
} }
// dispatchRequest fulfils a pending request and delivers it to the requested // dispatchResponse fulfils a pending request and delivers it to the requested
// sink. // sink.
func (p *Peer) dispatchResponse(res *Response, metadata func() interface{}) error { func (p *Peer) dispatchResponse(res *Response, metadata func() interface{}) error {
resOp := &response{ resOp := &response{

View File

@ -30,7 +30,7 @@ type Iterator struct {
inner *RawIterator inner *RawIterator
} }
// NewRawIterator returns a new Iterator instance. Next must be immediately // NewIterator returns a new Iterator instance. Next must be immediately
// called on new iterators to load the first item. // called on new iterators to load the first item.
func NewIterator(e *Era) (*Iterator, error) { func NewIterator(e *Era) (*Iterator, error) {
inner, err := NewRawIterator(e) inner, err := NewRawIterator(e)

View File

@ -148,7 +148,7 @@ func (NilSample) Clear() {}
func (NilSample) Snapshot() SampleSnapshot { return (*emptySnapshot)(nil) } func (NilSample) Snapshot() SampleSnapshot { return (*emptySnapshot)(nil) }
func (NilSample) Update(v int64) {} func (NilSample) Update(v int64) {}
// SamplePercentiles returns an arbitrary percentile of the slice of int64. // SamplePercentile returns an arbitrary percentile of the slice of int64.
func SamplePercentile(values []int64, p float64) float64 { func SamplePercentile(values []int64, p float64) float64 {
return CalculatePercentiles(values, []float64{p})[0] return CalculatePercentiles(values, []float64{p})[0]
} }

View File

@ -84,7 +84,7 @@ func OpenDB(path string) (*DB, error) {
return newPersistentDB(path) return newPersistentDB(path)
} }
// newMemoryNodeDB creates a new in-memory node database without a persistent backend. // newMemoryDB creates a new in-memory node database without a persistent backend.
func newMemoryDB() (*DB, error) { func newMemoryDB() (*DB, error) {
db, err := leveldb.Open(storage.NewMemStorage(), nil) db, err := leveldb.Open(storage.NewMemStorage(), nil)
if err != nil { if err != nil {
@ -93,7 +93,7 @@ func newMemoryDB() (*DB, error) {
return &DB{lvl: db, quit: make(chan struct{})}, nil return &DB{lvl: db, quit: make(chan struct{})}, nil
} }
// newPersistentNodeDB creates/opens a leveldb backed persistent node database, // newPersistentDB creates/opens a leveldb backed persistent node database,
// also flushing its contents in case of a version mismatch. // also flushing its contents in case of a version mismatch.
func newPersistentDB(path string) (*DB, error) { func newPersistentDB(path string) (*DB, error) {
opts := &opt.Options{OpenFilesCacheCapacity: 5} opts := &opt.Options{OpenFilesCacheCapacity: 5}

View File

@ -324,7 +324,7 @@ func (h *handler) addRequestOp(op *requestOp) {
} }
} }
// removeRequestOps stops waiting for the given request IDs. // removeRequestOp stops waiting for the given request IDs.
func (h *handler) removeRequestOp(op *requestOp) { func (h *handler) removeRequestOp(op *requestOp) {
for _, id := range op.ids { for _, id := range op.ids {
delete(h.respWait, string(id)) delete(h.respWait, string(id))

View File

@ -260,7 +260,7 @@ func fromHex(data any) ([]byte, error) {
return nil, fmt.Errorf("wrong type %T", data) return nil, fmt.Errorf("wrong type %T", data)
} }
// typeDataRequest tries to convert the data into a SignDataRequest. // typedDataRequest tries to convert the data into a SignDataRequest.
func typedDataRequest(data any) (*SignDataRequest, error) { func typedDataRequest(data any) (*SignDataRequest, error) {
var typedData apitypes.TypedData var typedData apitypes.TypedData
if td, ok := data.(apitypes.TypedData); ok { if td, ok := data.(apitypes.TypedData); ok {