Readme note about #transition_to error handling

gocardless · May 19, 2014 · ae8ed2a · ae8ed2a
1 parent 5cadb00
commit ae8ed2a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -231,7 +231,8 @@ Transition to the passed state, returning `true` on success. Raises
 
 #### `Machine#transition_to(:state)`
 Transition to the passed state, returning `true` on success. Swallows all
-exceptions and returns false on failure.
+Statesman exceptions and returns false on failure. (NB. if your guard or
+callback code throws an exception, it will not be caught.)
 
 ## Model scopes