Skip to content

Commit 829aae6

Browse files
author
Nishanth Shanmugham
committed
add a go language reference link to package doc
1 parent 143d79e commit 829aae6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ The Go [language spec] does not have an explicit definition for enums. For
1010
the purpose of this analyzer, and by convention, an enum type is any named
1111
type that:
1212
13-
- has underlying type float, string, or integer (includes byte and rune);
14-
and
13+
- has an [underlying type] of float, string, or integer (includes byte
14+
and rune); and
1515
- has at least one constant of its type defined in the same [block].
1616
1717
In the example below, Biome is an enum type. The three constants are its
@@ -209,6 +209,7 @@ To ignore specific types, specify the -ignore-enum-types flag:
209209
exhaustive -ignore-enum-types '^time\.Duration$|^example\.org/measure\.Unit$'
210210
211211
[language spec]: https://golang.org/ref/spec
212+
[underlying type]: https://golang.org/ref/spec#Underlying_types
212213
[block]: https://golang.org/ref/spec#Blocks
213214
[BasicKind]: https://pkg.go.dev/go/types#BasicKind
214215
*/

0 commit comments

Comments
 (0)