Add doc

Signed-off-by: Maxime Soulé <btik-git@scoubidou.com>
maxatome · Jun 18, 2018 · cf0b4e1 · cf0b4e1
1 parent 822ae5d
commit cf0b4e1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/td_code.go b/td_code.go
@@ -47,6 +47,8 @@ var _ TestDeep = &tdCode{}
 // confusion produced by output in case of failure. When the data
 // needs to be transformed before being compared again, Smuggle
 // operator should be used instead.
+//
+// TypeBehind method returns the reflect.Type of only parameter of "fn".
 func Code(fn interface{}) TestDeep {
 	vfn := reflect.ValueOf(fn)
 

diff --git a/td_smuggle.go b/td_smuggle.go
@@ -135,6 +135,8 @@ var _ TestDeep = &tdSmuggle{}
 // The difference between Smuggle and Code operators is that Code is
 // used to do a final comparison while Smuggle transforms the data and
 // then steps down in favor of generic comparison process.
+//
+// TypeBehind method returns the reflect.Type of only parameter of "fn".
 func Smuggle(fn interface{}, expectedValue interface{}) TestDeep {
 	vfn := reflect.ValueOf(fn)