DOC: lua: mention than txn:close was renamed txn:done.

Also indicate that it's not limited to error processing.

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index f8cfee26bcb4adf4a28c6c90bfb1109d8f603ca5..fa69e1f466ffeec0c7d95db52e1dfd859fb6b2c5 100644 (file)
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -931,10 +931,11 @@ TXN class
   :param class_txn txn: The class txn object containing the data.
   :returns: an array of headers.
 
-.. js:function:: TXN.close(txn)
+.. js:function:: TXN.done(txn)
 
-  This function close the transaction and the associated session. It can be
-  used when a critical error is detected.
+  This function terminates processing of the transaction and the associated
+  session. It can be used when a critical error is detected or to terminate
+  processing after some data have been returned to the client (eg: a redirect).
 
   :param class_txn txn: The class txn object containing the data.