From 4d9496f079dddd346e212dfb1f8916a38eb9c440 Mon Sep 17 00:00:00 2001 From: "John Paul E. Balandan, CPA" Date: Tue, 27 Oct 2026 16:32:10 +0800 Subject: [PATCH] docs: fix RST markup errors in the user guide --- user_guide_src/source/changelogs/v4.7.0.rst | 2 +- user_guide_src/source/general/common_functions.rst | 2 +- user_guide_src/source/general/urls.rst | 2 +- user_guide_src/source/guides/first-app/news_section.rst | 1 - user_guide_src/source/installation/upgrade_450.rst | 2 +- user_guide_src/source/installation/upgrade_4xx.rst | 2 +- user_guide_src/source/installation/upgrade_sessions.rst | 2 +- user_guide_src/source/libraries/email.rst | 2 +- 8 files changed, 7 insertions(+), 8 deletions(-) diff --git a/user_guide_src/source/changelogs/v4.7.0.rst b/user_guide_src/source/changelogs/v4.7.0.rst index d5d91b1cdc03..69c62c7c40ba 100644 --- a/user_guide_src/source/changelogs/v4.7.0.rst +++ b/user_guide_src/source/changelogs/v4.7.0.rst @@ -294,7 +294,7 @@ Libraries - **Encryption:** Added ``Config\Encryption::$previousKeys`` configuration option to support encryption key rotation. When decryption with the current key fails, the system automatically falls back to previous keys, allowing you to rotate encryption keys without losing access to old encrypted data. - **Image:** The ``ImageMagickHandler`` has been rewritten to rely solely on the PHP ``imagick`` extension. - **Image:** Added ``ImageMagickHandler::clearMetadata()`` method to remove image metadata for privacy protection. -- **ResponseTrait:** Added ``paginate``` method to simplify paginated API responses. See :ref:`ResponseTrait::paginate() ` for details. +- **ResponseTrait:** Added ``paginate()`` method to simplify paginated API responses. See :ref:`ResponseTrait::paginate() ` for details. - **Session:** Added ``persistent`` config item to ``RedisHandler``. - **Session:** Added connection persistence for Redis and Memcached session handlers via ``PersistsConnection`` trait, improving performance in worker mode by reusing connections across requests. - **Time:** added methods ``Time::addCalendarMonths()`` and ``Time::subCalendarMonths()`` diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index 1745b0e732e1..fcd1872dfb67 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -135,7 +135,7 @@ Service Accessors :param string $key: The name of the old form data to check for. :param string|null $default: The default value to return if $key doesn't exist. - :param false|string $escape: An `escape <#esc>`_ context or false to disable it. + :param false|string $escape: An :php:func:`esc()` context or false to disable it. :returns: The value of the defined key, or the default value. :rtype: array|string|null diff --git a/user_guide_src/source/general/urls.rst b/user_guide_src/source/general/urls.rst index bdb10508393f..aa11b265eb53 100644 --- a/user_guide_src/source/general/urls.rst +++ b/user_guide_src/source/general/urls.rst @@ -82,7 +82,7 @@ data can be passed to your application. URIs may only contain the following: - Colon: ``:`` - Underscore: ``_`` - Dash: ``-`` -- Space: `` `` +- Space character .. note:: This check is performed by the ``Router``. The Router takes the URL-encoded diff --git a/user_guide_src/source/guides/first-app/news_section.rst b/user_guide_src/source/guides/first-app/news_section.rst index 68dc21941cb4..1585e749152f 100644 --- a/user_guide_src/source/guides/first-app/news_section.rst +++ b/user_guide_src/source/guides/first-app/news_section.rst @@ -184,7 +184,6 @@ Create **app/Views/news/index.php** and add the next piece of code. Here, each news item is looped and displayed to the user. You can see we wrote our template in PHP mixed with HTML. If you prefer to use a template language, you can use CodeIgniter's :doc:`View Parser ` or a third party parser. -Parser ` or a third party parser. Complete News::show() Method ============================ diff --git a/user_guide_src/source/installation/upgrade_450.rst b/user_guide_src/source/installation/upgrade_450.rst index 3c4cdc4eddbe..ac590c3bb135 100644 --- a/user_guide_src/source/installation/upgrade_450.rst +++ b/user_guide_src/source/installation/upgrade_450.rst @@ -143,7 +143,7 @@ If you wish to maintain the same execution order as in previous versions, set Now: route → filters → globals 2. The After Filters in *Route* filters and *Filters* filters execution order is now -reversed. + reversed. When you have the following configuration: diff --git a/user_guide_src/source/installation/upgrade_4xx.rst b/user_guide_src/source/installation/upgrade_4xx.rst index 93340648278e..958d880c82d5 100644 --- a/user_guide_src/source/installation/upgrade_4xx.rst +++ b/user_guide_src/source/installation/upgrade_4xx.rst @@ -163,7 +163,7 @@ Helpers in CI3 are included in :doc:`../helpers/text_helper` in CI4. - In CI4, ``redirect()`` is completely changed from CI3's. - `redirect() Documentation CodeIgniter 3.x `_ - - `redirect() Documentation CodeIgniter 4.x <../general/common_functions.html#redirect>`_ + - :php:func:`redirect() Documentation CodeIgniter 4.x ` - In CI4, :php:func:`redirect()` returns a ``RedirectResponse`` instance instead of redirecting and terminating script execution. You must return it from Controllers or Controller Filters. diff --git a/user_guide_src/source/installation/upgrade_sessions.rst b/user_guide_src/source/installation/upgrade_sessions.rst index d03b1c465267..4460d44ded14 100644 --- a/user_guide_src/source/installation/upgrade_sessions.rst +++ b/user_guide_src/source/installation/upgrade_sessions.rst @@ -24,7 +24,7 @@ Upgrade Guide - To access session data use the syntax ``$session->item`` or ``$session->get('item')`` instead of the CI3 syntax ``$this->session->name``. - To set data use ``$session->set($array);`` instead of ``$this->session->set_userdata($array);``. - To remove data use ``unset($_SESSION['some_name']);`` or ``$session->remove('some_name');`` instead of ``$this->session->unset_userdata('some_name');``. - - To mark session data as flashdata, which will only be available for the next request, use ``$session->markAsFlashdata('item');`` instead of ``$this->session->mark_as_flash('item');``` + - To mark session data as flashdata, which will only be available for the next request, use ``$session->markAsFlashdata('item');`` instead of ``$this->session->mark_as_flash('item');`` 3. If you use Database Driver, you need to recreate the session table. See :ref:`sessions-databasehandler-driver`. Code Example diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst index b89d764e50f9..6c634f928650 100644 --- a/user_guide_src/source/libraries/email.rst +++ b/user_guide_src/source/libraries/email.rst @@ -201,7 +201,7 @@ Class Reference :rtype: CodeIgniter\\Email\\Email Sets the reply-to address. If the information is not provided the - information in the `setFrom <#setFrom>`_ method is used. Example: + information in the :php:meth:`setFrom()` method is used. Example: .. literalinclude:: email/005.php