all: fix docstring names (#28923)

* fix wrong comment

* reviewers input

* Update log/handler_glog.go

---------

Co-authored-by: Martin HS <martin@swende.se>
This commit is contained in:
zoereco 2024-02-07 21:10:49 +01:00 committed by GitHub
parent 69f5d5ba1f
commit 2ab365f6d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 13 additions and 13 deletions

View File

@ -83,7 +83,7 @@ func (b *BlockGen) SetDifficulty(diff *big.Int) {
b.header.Difficulty = diff b.header.Difficulty = diff
} }
// SetPos makes the header a PoS-header (0 difficulty) // SetPoS makes the header a PoS-header (0 difficulty)
func (b *BlockGen) SetPoS() { func (b *BlockGen) SetPoS() {
b.header.Difficulty = new(big.Int) b.header.Difficulty = new(big.Int)
} }

View File

@ -166,7 +166,7 @@ type G2 struct {
p *twistPoint p *twistPoint
} }
// RandomG1 returns x and g₂ˣ where x is a random, non-zero number read from r. // RandomG2 returns x and g₂ˣ where x is a random, non-zero number read from r.
func RandomG2(r io.Reader) (*big.Int, *G2, error) { func RandomG2(r io.Reader) (*big.Int, *G2, error) {
var k *big.Int var k *big.Int
var err error var err error

View File

@ -655,7 +655,7 @@ func (s *BlockChainAPI) GetBalance(ctx context.Context, address common.Address,
return (*hexutil.Big)(b), state.Error() return (*hexutil.Big)(b), state.Error()
} }
// Result structs for GetProof // AccountResult structs for GetProof
type AccountResult struct { type AccountResult struct {
Address common.Address `json:"address"` Address common.Address `json:"address"`
AccountProof []string `json:"accountProof"` AccountProof []string `json:"accountProof"`

View File

@ -192,7 +192,7 @@ func (h *GlogHandler) Handle(_ context.Context, r slog.Record) error {
frame, _ := fs.Next() frame, _ := fs.Next()
for _, rule := range h.patterns { for _, rule := range h.patterns {
if rule.pattern.MatchString(fmt.Sprintf("%+s", frame.File)) { if rule.pattern.MatchString(fmt.Sprintf("+%s", frame.File)) {
h.siteCache[r.PC], lvl, ok = rule.level, rule.level, true h.siteCache[r.PC], lvl, ok = rule.level, rule.level, true
} }
} }

View File

@ -8,7 +8,7 @@ type CounterSnapshot interface {
Count() int64 Count() int64
} }
// Counters hold an int64 value that can be incremented and decremented. // Counter hold an int64 value that can be incremented and decremented.
type Counter interface { type Counter interface {
Clear() Clear()
Dec(int64) Dec(int64)

View File

@ -2,12 +2,12 @@ package metrics
import "sync/atomic" import "sync/atomic"
// gaugeSnapshot contains a readonly int64. // GaugeSnapshot contains a readonly int64.
type GaugeSnapshot interface { type GaugeSnapshot interface {
Value() int64 Value() int64
} }
// Gauges hold an int64 value that can be set arbitrarily. // Gauge holds an int64 value that can be set arbitrarily.
type Gauge interface { type Gauge interface {
Snapshot() GaugeSnapshot Snapshot() GaugeSnapshot
Update(int64) Update(int64)

View File

@ -48,7 +48,7 @@ type gaugeFloat64Snapshot float64
// Value returns the value at the time the snapshot was taken. // Value returns the value at the time the snapshot was taken.
func (g gaugeFloat64Snapshot) Value() float64 { return float64(g) } func (g gaugeFloat64Snapshot) Value() float64 { return float64(g) }
// NilGauge is a no-op Gauge. // NilGaugeFloat64 is a no-op Gauge.
type NilGaugeFloat64 struct{} type NilGaugeFloat64 struct{}
func (NilGaugeFloat64) Snapshot() GaugeFloat64Snapshot { return NilGaugeFloat64{} } func (NilGaugeFloat64) Snapshot() GaugeFloat64Snapshot { return NilGaugeFloat64{} }

View File

@ -9,7 +9,7 @@ type GaugeInfoSnapshot interface {
Value() GaugeInfoValue Value() GaugeInfoValue
} }
// GaugeInfos hold a GaugeInfoValue value that can be set arbitrarily. // GaugeInfo holds a GaugeInfoValue value that can be set arbitrarily.
type GaugeInfo interface { type GaugeInfo interface {
Update(GaugeInfoValue) Update(GaugeInfoValue)
Snapshot() GaugeInfoSnapshot Snapshot() GaugeInfoSnapshot

View File

@ -1,6 +1,6 @@
package metrics package metrics
// Healthchecks hold an error value describing an arbitrary up/down status. // Healthcheck holds an error value describing an arbitrary up/down status.
type Healthcheck interface { type Healthcheck interface {
Check() Check()
Error() error Error() error

View File

@ -4,7 +4,7 @@ type HistogramSnapshot interface {
SampleSnapshot SampleSnapshot
} }
// Histograms calculate distribution statistics from a series of int64 values. // Histogram calculates distribution statistics from a series of int64 values.
type Histogram interface { type Histogram interface {
Clear() Clear()
Update(int64) Update(int64)

View File

@ -25,7 +25,7 @@ type v2Reporter struct {
write api.WriteAPI write api.WriteAPI
} }
// InfluxDBWithTags starts a InfluxDB reporter which will post the from the given metrics.Registry at each d interval with the specified tags // InfluxDBV2WithTags starts a InfluxDB reporter which will post the from the given metrics.Registry at each d interval with the specified tags
func InfluxDBV2WithTags(r metrics.Registry, d time.Duration, endpoint string, token string, bucket string, organization string, namespace string, tags map[string]string) { func InfluxDBV2WithTags(r metrics.Registry, d time.Duration, endpoint string, token string, bucket string, organization string, namespace string, tags map[string]string) {
rep := &v2Reporter{ rep := &v2Reporter{
reg: r, reg: r,

View File

@ -58,7 +58,7 @@ func newMeteredConn(conn UDPConn) UDPConn {
return &meteredUdpConn{UDPConn: conn} return &meteredUdpConn{UDPConn: conn}
} }
// Read delegates a network read to the underlying connection, bumping the udp ingress traffic meter along the way. // ReadFromUDP delegates a network read to the underlying connection, bumping the udp ingress traffic meter along the way.
func (c *meteredUdpConn) ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error) { func (c *meteredUdpConn) ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error) {
n, addr, err = c.UDPConn.ReadFromUDP(b) n, addr, err = c.UDPConn.ReadFromUDP(b)
ingressTrafficMeter.Mark(int64(n)) ingressTrafficMeter.Mark(int64(n))