Added a `transaction` convenience method that eliminates boilerplate when

using pipelines while WATCHing variables.

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
index f77f627..2a0a18a 100644
--- a/README.md
+++ b/README.md
@@ -217,6 +217,21 @@ explicity calling reset():
     ...     finally:
     ...         pipe.reset()
 
+A convenience method named "transaction" exists for handling all the
+boilerplate of handling and retrying watch errors. It takes a callable that
+should expect a single parameter, a pipeline object, and any number of keys to
+be WATCHED. Our client-side INCR command above can be written like this,
+which is much easier to read:
+
+    >>> def client_side_incr(pipe):
+    ...     current_value = pipe.get('OUR-SEQUENCE-KEY')
+    ...     next_value = int(current_value) + 1
+    ...     pipe.multi()
+    ...     pipe.set('OUR-SEQUENCE-KEY', next_value)
+    >>>
+    >>> r.transaction(client_side_incr, 'OUR-SEQUENCE-KEY')
+    [True]
+
 
 ## API Reference