diff --git a/doc.go b/doc.go index ad6f39f..96a6ceb 100644 --- a/doc.go +++ b/doc.go @@ -2,33 +2,33 @@ // // Tuple methods: // -// - Len returns the number of values held by the tuple. -// - Values returns the values held by the tuple. -// - Array returns an array of the tuple values. -// - Slice returns a slice of the tuple values. -// - String returns the string representation of the tuple. -// - GoString returns a Go-syntax representation of the tuple. +// * Len returns the number of values held by the tuple. +// * Values returns the values held by the tuple. +// * Array returns an array of the tuple values. +// * Slice returns a slice of the tuple values. +// * String returns the string representation of the tuple. +// * GoString returns a Go-syntax representation of the tuple. // // Tuple creation functions: // -// - New creates a new tuple holding N generic values. -// - FromArray returns a tuple from an array of length N. -// If any of the values can not be converted to the generic type, an error is returned. -// - FromArrayX returns a tuple from an array of length N. -// If any of the values can not be converted to the generic type, the function panics. -// - FromSlice returns a tuple from a slice of length N. -// 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. -// - FromSliceX returns a tuple from a slice of length N. -// 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. +// * New creates a new tuple holding N generic values. +// * FromArray returns a tuple from an array of length N. +// If any of the values can not be converted to the generic type, an error is returned. +// * FromArrayX returns a tuple from an array of length N. +// If any of the values can not be converted to the generic type, the function panics. +// * FromSlice returns a tuple from a slice of length N. +// 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. +// * FromSliceX returns a tuple from a slice of length N. +// 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. // // Tuple comparison functions: // -// - Equal returns whether the host tuple is equal to the other tuple. -// - Compare returns whether the host tuple is semantically less than, equal to, or greater than the guest tuple. -// - LessThan returns whether the host tuple is semantically less than the guest tuple. -// - LessOrEqual returns whether the host tuple is semantically less than or equal to the guest tuple. -// - GreaterThan returns whether the host tuple is semantically greater than the guest tuple. -// - GreaterOrEqual returns whether the host tuple is semantically greater than or equal to the guest tuple. +// * Equal returns whether the host tuple is equal to the other tuple. +// * Compare returns whether the host tuple is semantically less than, equal to, or greater than the guest tuple. +// * LessThan returns whether the host tuple is semantically less than the guest tuple. +// * LessOrEqual returns whether the host tuple is semantically less than or equal to the guest tuple. +// * GreaterThan returns whether the host tuple is semantically greater than the guest tuple. +// * GreaterOrEqual returns whether the host tuple is semantically greater than or equal to the guest tuple. // // Tuple comparison functions may have an "C" or "E" suffix as overload with additional supported type constraints. // Comparison functions ending with "C" accept the "Comparable" constraint.