Skip to content

Commit

Permalink
Merge pull request #86 from zopefoundation/exc-docs
Browse files Browse the repository at this point in the history
Publish the docs for the two explicit-mode exceptions added in 2.1.0.
  • Loading branch information
jamadden committed Dec 6, 2019
2 parents 38a5b34 + f7eb455 commit 27820f3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/api.rst
Expand Up @@ -58,6 +58,9 @@ Interfaces
:members:
:member-order: bysource

.. autoclass:: NoTransaction
.. autoclass:: AlreadyInTransaction

API Objects
-----------

Expand Down
2 changes: 1 addition & 1 deletion docs/datamanager.rst
Expand Up @@ -142,7 +142,7 @@ If there was a preceeding savepoint, the transaction must match:
>>> rollback = dm.savepoint(t1)
>>> dm.prepare(t2)
Traceback (most recent call last):
,,,
...
TypeError: ('Transaction missmatch', '2', '1')

>>> dm.prepare(t1)
Expand Down
2 changes: 1 addition & 1 deletion docs/resourcemanager.rst
Expand Up @@ -127,7 +127,7 @@ If there was a preceeding savepoint, the transaction must match:
>>> rollback = rm.savepoint(t1)
>>> rm.tpc_begin(t2)
Traceback (most recent call last):
,,,
...
TypeError: ('Transaction missmatch', '2', '1')

>>> rm.tpc_begin(t1)
Expand Down
8 changes: 7 additions & 1 deletion transaction/interfaces.py
Expand Up @@ -33,6 +33,8 @@ class ITransactionManager(Interface):
In explicit mode, transactions must be begun explicitly, by
calling ``begin()`` and ended explicitly by calling
``commit()`` or ``abort()``.
.. versionadded:: 2.1.0
""")


Expand Down Expand Up @@ -402,7 +404,7 @@ def addAfterAbortHook(hook, args=(), kws=None):
positional arguments to be passed, defaulting to an empty tuple
`kws` is a dictionary of keyword argument names and values to be
passed, or the default None (no keyword arguments are passed).
Multiple hooks can be registered and will be called in the order they
were registered (first registered, first called). This method can
also be called from a hook: an executing hook can register more
Expand Down Expand Up @@ -690,6 +692,8 @@ class NoTransaction(TransactionError):
affects an exciting transaction, but no transaction was begun.
The transaction manager was in explicit mode, so a new transaction
was not explicitly created.
.. versionadded:: 2.1.0
"""

class AlreadyInTransaction(TransactionError):
Expand All @@ -698,4 +702,6 @@ class AlreadyInTransaction(TransactionError):
An application called ``begin()`` on a transaction manager in
explicit mode, without committing or aborting the previous
transaction.
.. versionadded:: 2.1.0
"""

0 comments on commit 27820f3

Please sign in to comment.