Skip to content

Commit f902714

Browse files
committed
Explicitly document that canceling the future returned from
`Connection::transaction` does not close the transaction (It cannot due to the fact that there is no async drop in rust)
1 parent 756a885 commit f902714

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,10 @@ where
162162
/// If a nested transaction fails to release the corresponding savepoint
163163
/// the error will be returned directly.
164164
///
165+
/// **WARNING:** Cancling the returned future does currently **not**
166+
/// close an already open transaction. You may end up with a connection
167+
/// containing a dangling transaction.
168+
///
165169
/// # Example
166170
///
167171
/// ```rust

0 commit comments

Comments
 (0)