add changelog for #19

Pylons · Sep 30, 2019 · 65a5fdd · 65a5fdd
1 parent 889821b
commit 65a5fdd
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,3 +1,10 @@
+unreleased
+==========
+
+- Add ``exception`` and ``response`` attributes to the
+  ``pyramid_retry.IBeforeRetry`` event.
+  See https://github.com/Pylons/pyramid_retry/pull/19
+
 2.0 (2019-06-06)
 ================
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -179,7 +179,11 @@ on the ``environ`` itself that needs to be reset prior to the retry attempt.
 
     @subscriber(IBeforeRetry)
     def retry_event(event):
-        print('A retry is about to occur.')
+        print(f'A retry is about to occur due to {event.exception}.')
+
+The ``exception`` attribute indicates the exception that triggered the retry.
+The exception may come from either ``request.exception`` if it was caught and
+a response was rendered, or it may come from an uncaught exception.
 
 Caveats
 =======