From 757973c76acae3e71277434853a012561f80c5d7 Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 9 Nov 2023 07:36:21 +0900 Subject: [PATCH] docs: make note more accurate --- user_guide_src/source/incoming/filters.rst | 7 ++++--- user_guide_src/source/incoming/routing.rst | 8 +++++++- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/user_guide_src/source/incoming/filters.rst b/user_guide_src/source/incoming/filters.rst index 29462ccc6538..cee8515dcd54 100644 --- a/user_guide_src/source/incoming/filters.rst +++ b/user_guide_src/source/incoming/filters.rst @@ -204,7 +204,7 @@ filter:check .. versionadded:: 4.3.0 -Check the filters for the route ``/`` with **GET** method: +For example, check the filters for the route ``/`` with **GET** method: .. code-block:: console @@ -220,8 +220,9 @@ The output is like the following: | GET | / | | toolbar | +--------+-------+----------------+---------------+ -You can also see the routes and filters by the ``spark routes`` command. -See :ref:`URI Routing `. +You can also see the routes and filters by the ``spark routes`` command, +but it might not show accurate filters when you use regular expressions for routes. +See :ref:`URI Routing ` for details. **************** Provided Filters diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst index 0fa702ff10d2..8cb3e37718b8 100644 --- a/user_guide_src/source/incoming/routing.rst +++ b/user_guide_src/source/incoming/routing.rst @@ -907,7 +907,13 @@ The *Route* column shows the route path to match. The route of a defined route i Since v4.3.0, the *Name* column shows the route name. ``ยป`` indicates the name is the same as the route path. -.. important:: The system is not perfect. If you use Custom Placeholders, *Filters* might not be correct. If you want to check filters for a route, you can use :ref:`spark filter:check ` command. +.. important:: The system is not perfect. + For routes containing regular expression patterns like ``([^/]+)`` or ``{locale}``, + the *Filters* displayed might not be correct (if you set complicated URI pattern + for the filters in **app/Config/Filters.php**), or it is displayed as ````. + + The :ref:`spark filter:check ` command can be used to check + for 100% accurate filters. Auto Routing (Improved) -----------------------