Skip to content

Commit

Permalink
all: fix docstring names (ethereum#28923)
Browse files Browse the repository at this point in the history
* fix wrong comment

* reviewers input

* Update log/handler_glog.go

---------

Co-authored-by: Martin HS <martin@swende.se>
  • Loading branch information
zoereco and holiman authored Feb 7, 2024
1 parent 69f5d5b commit 2ab365f
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion core/chain_makers.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ func (b *BlockGen) SetDifficulty(diff *big.Int) {
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() {
b.header.Difficulty = new(big.Int)
}
Expand Down
2 changes: 1 addition & 1 deletion crypto/bn256/google/bn256.go
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ type G2 struct {
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) {
var k *big.Int
var err error
Expand Down
2 changes: 1 addition & 1 deletion internal/ethapi/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ func (s *BlockChainAPI) GetBalance(ctx context.Context, address common.Address,
return (*hexutil.Big)(b), state.Error()
}

// Result structs for GetProof
// AccountResult structs for GetProof
type AccountResult struct {
Address common.Address `json:"address"`
AccountProof []string `json:"accountProof"`
Expand Down
2 changes: 1 addition & 1 deletion log/handler_glog.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ func (h *GlogHandler) Handle(_ context.Context, r slog.Record) error {
frame, _ := fs.Next()

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
}
}
Expand Down
2 changes: 1 addition & 1 deletion metrics/counter.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type CounterSnapshot interface {
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 {
Clear()
Dec(int64)
Expand Down
4 changes: 2 additions & 2 deletions metrics/gauge.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ package metrics

import "sync/atomic"

// gaugeSnapshot contains a readonly int64.
// GaugeSnapshot contains a readonly int64.
type GaugeSnapshot interface {
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 {
Snapshot() GaugeSnapshot
Update(int64)
Expand Down
2 changes: 1 addition & 1 deletion metrics/gauge_float64.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ type gaugeFloat64Snapshot float64
// Value returns the value at the time the snapshot was taken.
func (g gaugeFloat64Snapshot) Value() float64 { return float64(g) }

// NilGauge is a no-op Gauge.
// NilGaugeFloat64 is a no-op Gauge.
type NilGaugeFloat64 struct{}

func (NilGaugeFloat64) Snapshot() GaugeFloat64Snapshot { return NilGaugeFloat64{} }
Expand Down
2 changes: 1 addition & 1 deletion metrics/gauge_info.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type GaugeInfoSnapshot interface {
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 {
Update(GaugeInfoValue)
Snapshot() GaugeInfoSnapshot
Expand Down
2 changes: 1 addition & 1 deletion metrics/healthcheck.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
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 {
Check()
Error() error
Expand Down
2 changes: 1 addition & 1 deletion metrics/histogram.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type HistogramSnapshot interface {
SampleSnapshot
}

// Histograms calculate distribution statistics from a series of int64 values.
// Histogram calculates distribution statistics from a series of int64 values.
type Histogram interface {
Clear()
Update(int64)
Expand Down
2 changes: 1 addition & 1 deletion metrics/influxdb/influxdbv2.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type v2Reporter struct {
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) {
rep := &v2Reporter{
reg: r,
Expand Down
2 changes: 1 addition & 1 deletion p2p/discover/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func newMeteredConn(conn UDPConn) UDPConn {
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) {
n, addr, err = c.UDPConn.ReadFromUDP(b)
ingressTrafficMeter.Mark(int64(n))
Expand Down

0 comments on commit 2ab365f

Please sign in to comment.