github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-22 11:21:47 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #115383 from my-git9/imporve/note

Browse Source 
Cleanup: improve some note for code
This commit is contained in:
Kubernetes Prow Robot 2023-01-31 17:05:07 -08:00 committed by GitHub
commit 39b1ec434e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
staging/src/k8s.io/apimachinery/pkg/util/duration/duration.go
View File

@ -21,7 +21,7 @@ import (
"time" "time"
) )
// ShortHumanDuration returns a succint representation of the provided duration // ShortHumanDuration returns a succinct representation of the provided duration
// with limited precision for consumption by humans. // with limited precision for consumption by humans.
func ShortHumanDuration(d time.Duration) string { func ShortHumanDuration(d time.Duration) string {
// Allow deviation no more than 2 seconds(excluded) to tolerate machine time // Allow deviation no more than 2 seconds(excluded) to tolerate machine time
@ -42,7 +42,7 @@ func ShortHumanDuration(d time.Duration) string {
return fmt.Sprintf("%dy", int(d.Hours()/24/365)) return fmt.Sprintf("%dy", int(d.Hours()/24/365))
} }
// HumanDuration returns a succint representation of the provided duration // HumanDuration returns a succinct representation of the provided duration
// with limited precision for consumption by humans. It provides ~2-3 significant // with limited precision for consumption by humans. It provides ~2-3 significant
// figures of duration. // figures of duration.
func HumanDuration(d time.Duration) string { func HumanDuration(d time.Duration) string {

2
staging/src/k8s.io/apimachinery/pkg/util/errors/errors.go
View File

@ -214,7 +214,7 @@ func CreateAggregateFromMessageCountMap(m MessageCountMap) Aggregate {
return NewAggregate(result) return NewAggregate(result)
} }
// Reduce will return err or, if err is an Aggregate and only has one item, // Reduce will return err or nil, if err is an Aggregate and only has one item,
// the first item in the aggregate. // the first item in the aggregate.
func Reduce(err error) error { func Reduce(err error) error {
if agg, ok := err.(Aggregate); ok && err != nil { if agg, ok := err.(Aggregate); ok && err != nil {

2
staging/src/k8s.io/apimachinery/pkg/util/framer/framer.go
View File

@ -32,7 +32,7 @@ func NewLengthDelimitedFrameWriter(w io.Writer) io.Writer {
return &lengthDelimitedFrameWriter{w: w} return &lengthDelimitedFrameWriter{w: w}
} }
// Write writes a single frame to the nested writer, prepending it with the length in // Write writes a single frame to the nested writer, prepending it with the length
// in bytes of data (as a 4 byte, bigendian uint32). // in bytes of data (as a 4 byte, bigendian uint32).
func (w *lengthDelimitedFrameWriter) Write(data []byte) (int, error) { func (w *lengthDelimitedFrameWriter) Write(data []byte) (int, error) {
binary.BigEndian.PutUint32(w.h[:], uint32(len(data))) binary.BigEndian.PutUint32(w.h[:], uint32(len(data)))