aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Amsterdam <jba@google.com>2022-02-11 08:54:29 -0500
committerJonathan Amsterdam <jba@google.com>2022-02-11 16:05:02 +0000
commitf2ec001845c3faaca152550f976a1ca904edce38 (patch)
tree5d9eef02d5e00a154af6e4257c73c2ef3b1be25d
parente50f0f372b07149e9cf16b8fec80d2d72efe2a87 (diff)
downloadgo-f2ec001845c3faaca152550f976a1ca904edce38.tar.gz
go-f2ec001845c3faaca152550f976a1ca904edce38.zip
go/doc: mark comparable predeclared
Add comparable to the list of predeclared types. Fixes golang/go#51141. Change-Id: I4a2d4e7e5680e115de9bca03b6c8ad454551cb82 Reviewed-on: https://go-review.googlesource.com/c/go/+/385114 Trust: Jonathan Amsterdam <jba@google.com> Run-TryBot: Jonathan Amsterdam <jba@google.com> Reviewed-by: Robert Findley <rfindley@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
-rw-r--r--src/go/doc/reader.go1
-rw-r--r--src/go/doc/testdata/b.0.golden3
-rw-r--r--src/go/doc/testdata/b.1.golden6
-rw-r--r--src/go/doc/testdata/b.2.golden3
-rw-r--r--src/go/doc/testdata/b.go6
5 files changed, 19 insertions, 0 deletions
diff --git a/src/go/doc/reader.go b/src/go/doc/reader.go
index de1d422106..d9e721d01b 100644
--- a/src/go/doc/reader.go
+++ b/src/go/doc/reader.go
@@ -927,6 +927,7 @@ var predeclaredTypes = map[string]bool{
"any": true,
"bool": true,
"byte": true,
+ "comparable": true,
"complex64": true,
"complex128": true,
"error": true,
diff --git a/src/go/doc/testdata/b.0.golden b/src/go/doc/testdata/b.0.golden
index 9d93392eaa..c06246a7b1 100644
--- a/src/go/doc/testdata/b.0.golden
+++ b/src/go/doc/testdata/b.0.golden
@@ -46,6 +46,9 @@ VARIABLES
FUNCTIONS
+ // Associated with comparable type if AllDecls is set.
+ func ComparableFactory() comparable
+
//
func F(x int) int
diff --git a/src/go/doc/testdata/b.1.golden b/src/go/doc/testdata/b.1.golden
index 66c47b5c2a..2b62c3400c 100644
--- a/src/go/doc/testdata/b.1.golden
+++ b/src/go/doc/testdata/b.1.golden
@@ -38,6 +38,12 @@ TYPES
//
func (x *T) M()
+ // Should only appear if AllDecls is set.
+ type comparable struct{} // overrides a predeclared type comparable
+
+ // Associated with comparable type if AllDecls is set.
+ func ComparableFactory() comparable
+
//
type notExported int
diff --git a/src/go/doc/testdata/b.2.golden b/src/go/doc/testdata/b.2.golden
index 9d93392eaa..c06246a7b1 100644
--- a/src/go/doc/testdata/b.2.golden
+++ b/src/go/doc/testdata/b.2.golden
@@ -46,6 +46,9 @@ VARIABLES
FUNCTIONS
+ // Associated with comparable type if AllDecls is set.
+ func ComparableFactory() comparable
+
//
func F(x int) int
diff --git a/src/go/doc/testdata/b.go b/src/go/doc/testdata/b.go
index e50663b3df..61b512bc8a 100644
--- a/src/go/doc/testdata/b.go
+++ b/src/go/doc/testdata/b.go
@@ -27,9 +27,15 @@ func UintFactory() uint {}
// Associated with uint type if AllDecls is set.
func uintFactory() uint {}
+// Associated with comparable type if AllDecls is set.
+func ComparableFactory() comparable {}
+
// Should only appear if AllDecls is set.
type uint struct{} // overrides a predeclared type uint
+// Should only appear if AllDecls is set.
+type comparable struct{} // overrides a predeclared type comparable
+
// ----------------------------------------------------------------------------
// Exported declarations associated with non-exported types must always be shown.