From 235f9cf2af212629d66a6227208b21ee1900aba3 Mon Sep 17 00:00:00 2001 From: jerkob Date: Tue, 28 Jan 2020 11:27:27 -0500 Subject: Update docs for `trans_active()` function` Per code review, update documentation from the proposed `trans_depth()` function to the replacement `trans_active()` function. --- user_guide_src/source/database/db_driver_reference.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'user_guide_src') diff --git a/user_guide_src/source/database/db_driver_reference.rst b/user_guide_src/source/database/db_driver_reference.rst index f1fbc1c87..ad53c2bfc 100644 --- a/user_guide_src/source/database/db_driver_reference.rst +++ b/user_guide_src/source/database/db_driver_reference.rst @@ -162,13 +162,12 @@ This article is intended to be a reference for them. Lets you retrieve the transaction status flag to determine if it has failed. - .. php:method:: trans_depth() + .. php:method:: trans_active() - :returns: The current transaction depth - :rtype: int + :returns: TRUE if a transaction is active, FALSE if not + :rtype: bool - Lets you retrieve the transaction depth value which - will be 1 or greater if a transaction is active. + Determines if a transaction is currently active. .. php:method:: compile_binds($sql, $binds) -- cgit v1.2.3-24-g4f1b