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 ad32d3e..d058949 100644
--- a/src/crypto/rsa/rsa.go
+++ b/src/crypto/rsa/rsa.go
@@ -555,7 +555,7 @@
}
// 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 b18996a..3f34bc5 100644
--- a/src/encoding/csv/writer.go
+++ b/src/encoding/csv/writer.go
@@ -41,7 +41,7 @@
}
}
-// 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 c0dc053..13b5c99 100644
--- a/src/expvar/expvar.go
+++ b/src/expvar/expvar.go
@@ -205,7 +205,7 @@
}
}
-// 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 b50ee2f..409b468 100644
--- a/src/go/types/scope.go
+++ b/src/go/types/scope.go
@@ -42,7 +42,7 @@
// 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 @@
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 0c007f6..31c572f 100644
--- a/src/go/types/typestring.go
+++ b/src/go/types/typestring.go
@@ -24,7 +24,7 @@
//
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 e090780..75207db 100644
--- a/src/net/mail/message.go
+++ b/src/net/mail/message.go
@@ -148,7 +148,7 @@
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()
}
