summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2015-12-12 16:26:28 +0100
committerAndrey Andreev <narf@devilix.net>2015-12-12 16:26:28 +0100
commit97ecf2fcce8e3133e286e16de1b49612235a8dcf (patch)
tree4f71af35679ae7812f6624aaed48821896d12ca8 /user_guide_src
parentc424b3e1e3d95d06a32b5a9d35fa294b11384a8a (diff)
Complete the proposed changes from PR #4300
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/changelog.rst2
-rw-r--r--user_guide_src/source/database/db_driver_reference.rst1
2 files changed, 2 insertions, 1 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 5a41fa18b..1ea34eee6 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -13,7 +13,7 @@ Release Date: Not Released
- Database
- - CI_DB_driver::initialize() throws a "Database connection failure." RuntimeException if couldn't connect to the database.
+ - Failure to initialize a database connection will now throw a ``RuntimeException``.
Version 3.0.4
diff --git a/user_guide_src/source/database/db_driver_reference.rst b/user_guide_src/source/database/db_driver_reference.rst
index 1e436ede1..f0a438883 100644
--- a/user_guide_src/source/database/db_driver_reference.rst
+++ b/user_guide_src/source/database/db_driver_reference.rst
@@ -19,6 +19,7 @@ This article is intended to be a reference for them.
:returns: TRUE on success, FALSE on failure
:rtype: bool
+ :throws: RuntimeException In case of failure
Initialize database settings, establish a connection to
the database.