Skip to content

Commit 1bba51d

Browse files
authored
Merge pull request #7037 from kenjis/fix-docs-cli_commands.rst
docs: update deprecated `migrate:create` examples
2 parents e34a05b + 1b2be9f commit 1bba51d

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

user_guide_src/source/cli/cli_commands.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ and must extend ``CodeIgniter\CLI\BaseCommand``, and implement the ``run()`` met
2222
The following properties should be used in order to get listed in CLI commands and to add help functionality to your command:
2323

2424
* ``$group``: a string to describe the group the command is lumped under when listing commands. For example: ``Database``
25-
* ``$name``: a string to describe the command's name. For example: ``migrate:create``
26-
* ``$description``: a string to describe the command. For example: ``Creates a new migration file.``
27-
* ``$usage``: a string to describe the command usage. For example: ``migrate:create [name] [options]``
28-
* ``$arguments``: an array of strings to describe each command argument. For example: ``'name' => 'The migration file name'``
29-
* ``$options``: an array of strings to describe each command option. For example: ``'-n' => 'Set migration namespace'``
25+
* ``$name``: a string to describe the command's name. For example: ``make:controller``
26+
* ``$description``: a string to describe the command. For example: ``Generates a new controller file.``
27+
* ``$usage``: a string to describe the command usage. For example: ``make:controller <name> [options]``
28+
* ``$arguments``: an array of strings to describe each command argument. For example: ``'name' => 'The controller class name.'``
29+
* ``$options``: an array of strings to describe each command option. For example: ``'--force' => 'Force overwrite existing file.'``
3030

3131
**Help description will be automatically generated according to the above parameters.**
3232

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<?php
22

3-
echo command('migrate:create TestMigration');
3+
echo command('make:migration TestMigration');

user_guide_src/source/cli/cli_generators.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ where ``<generator_command>`` will be replaced with the command to check.
3434
namespace defined in your ``$psr4`` array in ``Config\Autoload`` or defined in your composer autoload
3535
file. Otherwise, code generation will be interrupted.
3636

37-
.. important:: Use of ``migrate:create`` to create migration files is now deprecated. It will be removed in
37+
.. important:: Since v4.0.5, use of ``migrate:create`` to create migration files has been deprecated. It will be removed in
3838
future releases. Please use ``make:migration`` as replacement. Also, please use ``make:migration --session``
3939
to use instead of the deprecated ``session:migration``.
4040

0 commit comments

Comments
 (0)