all: change some function documentation to be more idiomatic

Change-Id: I932de9bb061a8ba3332ef03207983e8b98d6f1e5
Reviewed-on: https://go-review.googlesource.com/c/go/+/187918
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>

diff --git a/src/crypto/rsa/rsa.go b/src/crypto/rsa/rsa.go
index ad32d3e3add0fc44cfbac9921a708030c041e6a4..d058949242d034fb89db0ed833ec479eb8c5c1a8 100644 (file)
--- a/src/crypto/rsa/rsa.go
+++ b/src/crypto/rsa/rsa.go
@@ -555,7 +555,7 @@ func decryptAndCheck(random io.Reader, priv *PrivateKey, c *big.Int) (m *big.Int
 }
 
 // DecryptOAEP decrypts ciphertext using RSA-OAEP.
-
+//
 // OAEP is parameterised by a hash function that is used as a random oracle.
 // Encryption and decryption of a given message must use the same hash function
 // and sha256.New() is a reasonable choice.

diff --git a/src/encoding/csv/writer.go b/src/encoding/csv/writer.go
index b18996a930d307eb3c7f6bbdce0faadfa7a532df..3f34bc51dbfc0ddb705771b75436a17203175337 100644 (file)
--- a/src/encoding/csv/writer.go
+++ b/src/encoding/csv/writer.go
@@ -41,7 +41,7 @@ func NewWriter(w io.Writer) *Writer {
        }
 }
 
-// Writer writes a single CSV record to w along with any necessary quoting.
+// Write writes a single CSV record to w along with any necessary quoting.
 // A record is a slice of strings with each string being one field.
 // Writes are buffered, so Flush must eventually be called to ensure
 // that the record is written to the underlying io.Writer.

diff --git a/src/expvar/expvar.go b/src/expvar/expvar.go
index c0dc0532b1ca4bb2f9e809c87d4afcfdfadc96d4..13b5c99b6e536fef7c6c978e5322519243e85c44 100644 (file)
--- a/src/expvar/expvar.go
+++ b/src/expvar/expvar.go
@@ -205,7 +205,7 @@ func (v *Map) AddFloat(key string, delta float64) {
        }
 }
 
-// Deletes the given key from the map.
+// Delete deletes the given key from the map.
 func (v *Map) Delete(key string) {
        v.keysMu.Lock()
        defer v.keysMu.Unlock()

diff --git a/src/go/types/scope.go b/src/go/types/scope.go
index b50ee2fd5f38d89c4cecc83d7913a8b2aecb5ff5..409b468f20a311c43e0e5db5a12e5f518d3399a7 100644 (file)
--- a/src/go/types/scope.go
+++ b/src/go/types/scope.go
@@ -42,7 +42,7 @@ func NewScope(parent *Scope, pos, end token.Pos, comment string) *Scope {
 // Parent returns the scope's containing (parent) scope.
 func (s *Scope) Parent() *Scope { return s.parent }
 
-// Len() returns the number of scope elements.
+// Len returns the number of scope elements.
 func (s *Scope) Len() int { return len(s.elems) }
 
 // Names returns the scope's element names in sorted order.
@@ -57,7 +57,7 @@ func (s *Scope) Names() []string {
        return names
 }
 
-// NumChildren() returns the number of scopes nested in s.
+// NumChildren returns the number of scopes nested in s.
 func (s *Scope) NumChildren() int { return len(s.children) }
 
 // Child returns the i'th child scope for 0 <= i < NumChildren().

diff --git a/src/go/types/typestring.go b/src/go/types/typestring.go
index 0c007f6cd0155157af9d018004ee84d3968a2038..31c572f83b1234f8c48ad83a8d26513bce8343f0 100644 (file)
--- a/src/go/types/typestring.go
+++ b/src/go/types/typestring.go
@@ -24,7 +24,7 @@ import (
 //
 type Qualifier func(*Package) string
 
-// RelativeTo(pkg) returns a Qualifier that fully qualifies members of
+// RelativeTo returns a Qualifier that fully qualifies members of
 // all packages other than pkg.
 func RelativeTo(pkg *Package) Qualifier {
        if pkg == nil {

diff --git a/src/net/mail/message.go b/src/net/mail/message.go
index e0907806ca6e337465753e38cb33d4c7f4ca36c5..75207db4342cbe64a2a43b66ba1717695da8c337 100644 (file)
--- a/src/net/mail/message.go
+++ b/src/net/mail/message.go
@@ -148,7 +148,7 @@ type Address struct {
        Address string // user@domain
 }
 
-// Parses a single RFC 5322 address, e.g. "Barry Gibbs <bg@example.com>"
+// ParseAddress parses a single RFC 5322 address, e.g. "Barry Gibbs <bg@example.com>"
 func ParseAddress(address string) (*Address, error) {
        return (&addrParser{s: address}).parseSingleAddress()
 }