Added docs for DbMap.TableFor

mattc58 · May 16, 2014 · 214aeb9 · 214aeb9
1 parent 4593fad
commit 214aeb9
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/gorp.go b/gorp.go
@@ -1077,6 +1077,9 @@ func (m *DbMap) Begin() (*Transaction, error) {
 	return &Transaction{m, tx, false}, nil
 }
 
+// TableFor returns the *TableMap corresponding to the given Go Type
+// If no table is mapped to that type an error is returned.
+// If checkPK is true and the mapped table has no registered PKs, an error is returned.
 func (m *DbMap) TableFor(t reflect.Type, checkPK bool) (*TableMap, error) {
 	table := tableOrNil(m, t)
 	if table == nil {