Skip to content

Commit 6da0e7a

Browse files
committed
docs: typo
Signed-off-by: Maxime Soulé <btik-git@scoubidou.com>
1 parent dd50fba commit 6da0e7a

File tree

5 files changed

+14
-8
lines changed

5 files changed

+14
-8
lines changed

td/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
// with a value included between the date before CreateRecord() call
113113
// and the date just after.
114114
//
115-
// Note that if `Id` and `CreateAt` could be known in advance, we could
115+
// Note that if Id and CreateAt could be known in advance, we could
116116
// simply do:
117117
//
118118
// import (

td/t_anchor.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ func AddAnchorableStructType(fn any) {
6161
// below). Otherwise, model should contain only one value
6262
// corresponding to the returning type. It can be:
6363
// - a go value: returning type is the type of the value,
64-
// whatever the value is
65-
// - a [reflect.Type]
64+
// whatever the value is;
65+
// - a [reflect.Type].
6666
//
6767
// It returns a typed value ready to be embed in a go data structure to
6868
// be compared using [T.Cmp] or [T.CmpLax]:

td/t_hooks.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
//
2222
// First arg is always got, and second is always expected.
2323
//
24-
// A cannot be an interface. This retriction can be removed in the
24+
// A cannot be an interface. This restriction can be removed in the
2525
// future, if really needed.
2626
//
2727
// This function is called as soon as possible each time the type A is
@@ -30,7 +30,7 @@ import (
3030
// When it returns a bool, false means A is not equal to B.
3131
//
3232
// When it returns a non-nil error (meaning got ≠ expected), its
33-
// contents is used to tell the reason of the failure.
33+
// content is used to tell the reason of the failure.
3434
//
3535
// Cmp hooks are checked before [UseEqual] feature.
3636
//
@@ -100,7 +100,7 @@ func (t *T) WithCmpHooks(fns ...any) *T {
100100
// func (got A) B
101101
// func (got A) (B, error)
102102
//
103-
// A cannot be an interface. This retriction can be removed in the
103+
// A cannot be an interface. This restriction can be removed in the
104104
// future, if really needed.
105105
//
106106
// B cannot be an interface. If you have a use case, we can talk about it.
@@ -114,7 +114,7 @@ func (t *T) WithCmpHooks(fns ...any) *T {
114114
//
115115
// When it returns non-nil error (meaning something wrong happened
116116
// during the conversion of A to B), it raises a global error and its
117-
// contents is used to tell the reason of the failure.
117+
// content is used to tell the reason of the failure.
118118
//
119119
// Smuggle hooks are run just before Cmp hooks.
120120
//

td/t_struct.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -780,6 +780,8 @@ func getTrace(args ...any) string {
780780
// added. If len(args) > 1 and the first item of args is a string
781781
// and contains a '%' rune then [fmt.Fprintf] is used to compose the
782782
// name, else args are passed to [fmt.Fprint].
783+
//
784+
// See also [T.ErrorTrace] and [T.FatalTrace].
783785
func (t *T) LogTrace(args ...any) {
784786
t.Helper()
785787
t.Log(getTrace(args...))
@@ -793,6 +795,8 @@ func (t *T) LogTrace(args ...any) {
793795
// added. If len(args) > 1 and the first item of args is a string
794796
// and contains a '%' rune then [fmt.Fprintf] is used to compose the
795797
// name, else args are passed to [fmt.Fprint].
798+
//
799+
// See also [T.LogTrace] and [T.FatalTrace].
796800
func (t *T) ErrorTrace(args ...any) {
797801
t.Helper()
798802
t.Error(getTrace(args...))
@@ -806,6 +810,8 @@ func (t *T) ErrorTrace(args ...any) {
806810
// added. If len(args) > 1 and the first item of args is a string
807811
// and contains a '%' rune then [fmt.Fprintf] is used to compose the
808812
// name, else args are passed to [fmt.Fprint].
813+
//
814+
// See also [T.LogTrace] and [T.ErrorTrace].
809815
func (t *T) FatalTrace(args ...any) {
810816
t.Helper()
811817
t.Fatal(getTrace(args...))

td/td_between.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ type tdBetween struct {
3636

3737
var _ TestDeep = &tdBetween{}
3838

39-
// BoundsKind type qualifies the "Between" bounds.
39+
// BoundsKind type qualifies the [Between] bounds.
4040
type BoundsKind uint8
4141

4242
const (

0 commit comments

Comments
 (0)