Skip to content

Commit

Permalink
Merge pull request #6594 from kenjis/fix-docs-deprecate
Browse files Browse the repository at this point in the history
docs: change note type for deprecation to `important`
  • Loading branch information
kenjis authored Sep 27, 2022
2 parents 8cedb51 + 16d2ef7 commit 1dbaa18
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion user_guide_src/source/cli/cli_generators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ where ``<generator_command>`` will be replaced with the command to check.
namespace defined in your ``$psr4`` array in ``Config\Autoload`` or defined in your composer autoload
file. Otherwise, code generation will be interrupted.

.. warning:: Use of ``migrate:create`` to create migration files is now deprecated. It will be removed in
.. important:: Use of ``migrate:create`` to create migration files is now deprecated. It will be removed in
future releases. Please use ``make:migration`` as replacement. Also, please use ``make:migration --session``
to use instead of the deprecated ``session:migration``.

Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/extending/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.
.. important:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. These will be removed in future releases.

Once sorted, all subscribers are executed in order. If any subscriber returns a boolean false value, then execution of
the subscribers will stop.
Expand Down
4 changes: 2 additions & 2 deletions user_guide_src/source/incoming/request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Class Reference

.. php:method:: isValidIP($ip[, $which = ''])
.. important:: This method is deprecated.
.. important:: This method is deprecated. It will be removed in future releases.

:param string $ip: IP address
:param string $which: IP protocol ('ipv4' or 'ipv6')
Expand All @@ -53,7 +53,7 @@ Class Reference

.. php:method:: getMethod([$upper = false])
.. important:: Use of the ``$upper`` parameter is deprecated.
.. important:: Use of the ``$upper`` parameter is deprecated. It will be removed in future releases.

:param bool $upper: Whether to return the request method name in upper or lower case
:returns: HTTP request method
Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/libraries/cookies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ Class Reference

.. php:method:: withNeverExpiring()
.. important:: This method is deprecated.
.. important:: This method is deprecated. It will be removed in future releases.

:param string $name:
:rtype: ``Cookie``
Expand Down

0 comments on commit 1dbaa18

Please sign in to comment.