Browse Source

Correct documentation for isSavePointsEnabled()

Mark Story 5 years ago
parent
commit
72b0b8698a
1 changed files with 2 additions and 7 deletions
  1. 2 7
      src/Database/Connection.php

+ 2 - 7
src/Database/Connection.php

@@ -584,13 +584,8 @@ class Connection implements ConnectionInterface
     /**
      * Enables/disables the usage of savepoints, enables only if driver the allows it.
      *
-     * If you are trying to enable this feature, make sure you check the return value of this
-     * function to verify it was enabled successfully.
-     *
-     * ### Example:
-     *
-     * `$connection->enableSavePoints(true)` Returns true if drivers supports save points, false otherwise
-     * `$connection->enableSavePoints(false)` Disables usage of savepoints and returns false
+     * If you are trying to enable this feature, make sure you check
+     * `isSavePointsEnabled()` to verify that savepoints were enabled successfully.
      *
      * @param bool $enable Whether or not save points should be used.
      * @return $this