summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2015-05-22 12:04:06 +0200
committerAndrey Andreev <narf@devilix.net>2015-05-22 12:04:06 +0200
commitda71f5aa255fc6fd26452664e730ea4297905ed3 (patch)
tree46c7b1f2db8544e84d724577cd9f5a8ad6a41836
parent3a4f9cd467b23ca5aeb93d20214685c86c0d520c (diff)
parent8d132bb1e999c2b2bdc2125d6d4ec36649556fc7 (diff)
Merge pull request #3868 from ftwbzhao/feature/migration
[ci skip] Update Migration lib class reference docs
-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..45a3cbbce 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..97c72303c 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