summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorftwbzhao <b.zhao1@gmail.com>2015-05-20 10:10:35 +0200
committerftwbzhao <b.zhao1@gmail.com>2015-05-20 10:17:11 +0200
commitb8978ee517fab43fea511869337ac40b577f00a3 (patch)
tree01a30c745f0b53362b763f39b827dfb04707bf61
parent20bd19dfe6c408925a937b4a6de93a74a853c372 (diff)
optimize migrations class reference
-rw-r--r--system/libraries/Migration.php6
-rw-r--r--user_guide_src/source/libraries/migration.rst2
2 files changed, 4 insertions, 4 deletions
diff --git a/system/libraries/Migration.php b/system/libraries/Migration.php
index ae36a3b45..e17f41696 100644
--- a/system/libraries/Migration.php
+++ b/system/libraries/Migration.php
@@ -191,7 +191,7 @@ class CI_Migration {
* choice
*
* @param string $target_version Target schema version
- * @return mixed TRUE if already latest, FALSE if failed, string if upgraded
+ * @return mixed TRUE if no migrations are found, current version string on success, FALSE on failure
*/
public function version($target_version)
{
@@ -294,7 +294,7 @@ class CI_Migration {
/**
* Sets the schema to the latest migration
*
- * @return mixed TRUE if already latest, FALSE if failed, string if upgraded
+ * @return mixed current version string on success, FALSE on failure
*/
public function latest()
{
@@ -318,7 +318,7 @@ class CI_Migration {
/**
* Sets the schema to the migration version set in config
*
- * @return mixed TRUE if already current, FALSE if failed, string if upgraded
+ * @return mixed TRUE if no migrations are found, current version string on success, FALSE on failure
*/
public function current()
{
diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst
index 9eb9b78b1..0f386aa39 100644
--- a/user_guide_src/source/libraries/migration.rst
+++ b/user_guide_src/source/libraries/migration.rst
@@ -164,7 +164,7 @@ Class Reference
.. php:method:: latest()
- :returns: TRUE if no migrations are found, current version string on success, FALSE on failure
+ :returns: current version string on success, FALSE on failure
:rtype: mixed
This works much the same way as ``current()`` but instead of looking for