Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit c260fac

Browse files
committed
Rewrote actions
1 parent 1cb898a commit c260fac

File tree

3 files changed

+12
-25
lines changed

3 files changed

+12
-25
lines changed

bundles/routing_auto/exists_actions.rst

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Path Exists Actions
55
-------------------
66

77
These are the default actions available to take if the path provided by a
8-
`path_provider` already exists and so creating a new path would create a
8+
``path_provider`` already exists and so creating a new path would create a
99
conflict.
1010

1111
auto_increment
@@ -18,9 +18,7 @@ it finds a path which *doesn't* exist.
1818

1919
This action should typically be used in the ``content_name`` builder unit to
2020
resolve conflicts. Using it in the ``content_path`` builder chain would not
21-
make much sense (I can't imagine any use cases at the moment).
22-
23-
Example:
21+
make much sense.
2422

2523
.. configuration-block::
2624

@@ -43,17 +41,14 @@ use
4341
~~~
4442

4543
The ``use`` action will simply take the existing path and use it. For example,
46-
in our post example the first builder unit must first determine the blogs
47-
path, ``/my/blog``, if this path exists (and it should) then we will *use* it
48-
in the stack.
44+
in a forum the builder unit must first determine the category path, ``/my-category``,
45+
if this path exists (and it should) then it will be *used* in the stack.
4946

5047
This action should typically be used in one of the content path builder units
51-
to specify that we should use the existing route, on the other hand, using
48+
to specify that it should use the existing route. On the other hand, using
5249
this as the content name builder action should cause the old route to be
5350
overwritten.
5451

55-
Example:
56-
5752
.. configuration-block::
5853

5954
.. code-block:: yaml

bundles/routing_auto/not_exists_actions.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ These are the default actions available to take if the path provided by a
1010
create
1111
~~~~~~
1212

13-
The ``create`` action will create the path. **currently** all routes provided
14-
by the content path build units will be created as ``Generic`` documents,
15-
whilst the content name route will be created as an ``AutoRoute`` document.
13+
The ``create`` action will create the path.
1614

1715
.. configuration-block::
1816

@@ -31,6 +29,12 @@ whilst the content name route will be created as an ``AutoRoute`` document.
3129
'not_exists_action' => 'create',
3230
);
3331
32+
.. note::
33+
34+
**Currently** all routes provided by the content path build units will be
35+
created as ``Generic`` documents, whilst the content name route will be
36+
created as an ``AutoRoute`` document.
37+
3438
throw_exception
3539
~~~~~~~~~~~~~~~
3640

bundles/routing_auto/providers.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ Options
2222

2323
* ``path`` - **required** The path to provide.
2424

25-
Example
26-
.......
27-
2825
.. configuration-block::
2926

3027
.. code-block:: yaml
@@ -67,9 +64,6 @@ Options
6764

6865
- ``method``: **required** Method used to return the document whose route path you wish to use.
6966

70-
Example
71-
.......
72-
7367
.. configuration-block::
7468

7569
.. code-block:: yaml
@@ -109,9 +103,6 @@ Options
109103
* ``method``: **required** Method used to return the route name/path/path elements.
110104
* ``slugify``: If the return value should be slugified, default is ``true``.
111105

112-
Example
113-
.......
114-
115106
.. configuration-block::
116107

117108
.. code-block:: yaml
@@ -167,9 +158,6 @@ content_datetime
167158
The ``content_datettime`` provider will provide a path from a ``DateTime``
168159
object provided by a designated method on the content document.
169160

170-
Example
171-
.......
172-
173161
.. configuration-block::
174162

175163
.. code-block:: yaml

0 commit comments

Comments
 (0)