Skip to content

Commit 24bbf8e

Browse files
authored
Fix package documentation to look better in go reference (#14)
1 parent 5f07ced commit 24bbf8e

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

doc.go

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22
//
33
// Tuple methods:
44
//
5-
// - Len returns the number of values held by the tuple.
6-
// - Values returns the values held by the tuple.
7-
// - Array returns an array of the tuple values.
8-
// - Slice returns a slice of the tuple values.
9-
// - String returns the string representation of the tuple.
10-
// - GoString returns a Go-syntax representation of the tuple.
5+
// * Len returns the number of values held by the tuple.
6+
// * Values returns the values held by the tuple.
7+
// * Array returns an array of the tuple values.
8+
// * Slice returns a slice of the tuple values.
9+
// * String returns the string representation of the tuple.
10+
// * GoString returns a Go-syntax representation of the tuple.
1111
//
1212
// Tuple creation functions:
1313
//
14-
// - New<N> creates a new tuple holding N generic values.
15-
// - FromArray<N> returns a tuple from an array of length N.
16-
// If any of the values can not be converted to the generic type, an error is returned.
17-
// - FromArray<N>X returns a tuple from an array of length N.
18-
// If any of the values can not be converted to the generic type, the function panics.
19-
// - FromSlice<N> returns a tuple from a slice of length N.
20-
// If the length of the slice doesn't match, or any of the values can not be converted to the generic type, an error is returned.
21-
// - FromSlice<N>X returns a tuple from a slice of length N.
22-
// If the length of the slice doesn't match, or any of the values can not be converted to the generic type, the function panics.
14+
// * New<N> creates a new tuple holding N generic values.
15+
// * FromArray<N> returns a tuple from an array of length N.
16+
// If any of the values can not be converted to the generic type, an error is returned.
17+
// * FromArray<N>X returns a tuple from an array of length N.
18+
// If any of the values can not be converted to the generic type, the function panics.
19+
// * FromSlice<N> returns a tuple from a slice of length N.
20+
// If the length of the slice doesn't match, or any of the values can not be converted to the generic type, an error is returned.
21+
// * FromSlice<N>X returns a tuple from a slice of length N.
22+
// If the length of the slice doesn't match, or any of the values can not be converted to the generic type, the function panics.
2323
//
2424
// Tuple comparison functions:
2525
//
26-
// - Equal<N> returns whether the host tuple is equal to the other tuple.
27-
// - Compare<N> returns whether the host tuple is semantically less than, equal to, or greater than the guest tuple.
28-
// - LessThan<N> returns whether the host tuple is semantically less than the guest tuple.
29-
// - LessOrEqual<N> returns whether the host tuple is semantically less than or equal to the guest tuple.
30-
// - GreaterThan<N> returns whether the host tuple is semantically greater than the guest tuple.
31-
// - GreaterOrEqual<N> returns whether the host tuple is semantically greater than or equal to the guest tuple.
26+
// * Equal<N> returns whether the host tuple is equal to the other tuple.
27+
// * Compare<N> returns whether the host tuple is semantically less than, equal to, or greater than the guest tuple.
28+
// * LessThan<N> returns whether the host tuple is semantically less than the guest tuple.
29+
// * LessOrEqual<N> returns whether the host tuple is semantically less than or equal to the guest tuple.
30+
// * GreaterThan<N> returns whether the host tuple is semantically greater than the guest tuple.
31+
// * GreaterOrEqual<N> returns whether the host tuple is semantically greater than or equal to the guest tuple.
3232
//
3333
// Tuple comparison functions may have an "C" or "E" suffix as overload with additional supported type constraints.
3434
// Comparison functions ending with "C" accept the "Comparable" constraint.

0 commit comments

Comments
 (0)