Skip to content

Commit 2525b82

Browse files
committed
remove state machine docs
1 parent 4abfbd5 commit 2525b82

1 file changed

Lines changed: 0 additions & 38 deletions

File tree

‎docs/routing.rst‎

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,6 @@ Maps, Rules and Adapters
127127
:members: empty
128128

129129

130-
Matchers
131-
========
132-
133-
.. autoclass:: StateMachineMatcher
134-
:members:
135-
136-
137130
Rule Factories
138131
==============
139132

@@ -274,34 +267,3 @@ scheme and host, ``force_external=True`` is implied.
274267
275268
url = adapter.build("comm")
276269
assert url == "ws://example.org/ws"
277-
278-
279-
State Machine Matching
280-
======================
281-
282-
The default matching algorithm uses a state machine that transitions
283-
between parts of the request path to find a match. To understand how
284-
this works consider this rule::
285-
286-
/resource/<id>
287-
288-
Firstly this rule is decomposed into two ``RulePart``. The first is a
289-
static part with a content equal to ``resource``, the second is
290-
dynamic and requires a regex match to ``[^/]+``.
291-
292-
A state machine is then created with an initial state that represents
293-
the rule's first ``/``. This initial state has a single, static
294-
transition to the next state which represents the rule's second
295-
``/``. This second state has a single dynamic transition to the final
296-
state which includes the rule.
297-
298-
To match a path the matcher starts and the initial state and follows
299-
transitions that work. Clearly a trial path of ``/resource/2`` has the
300-
parts ``""``, ``resource``, and ``2`` which match the transitions and
301-
hence a rule will match. Whereas ``/other/2`` will not match as there
302-
is no transition for the ``other`` part from the initial state.
303-
304-
The only diversion from this rule is if a ``RulePart`` is not
305-
part-isolating i.e. it will match ``/``. In this case the ``RulePart``
306-
is considered final and represents a transition that must include all
307-
the subsequent parts of the trial path.

0 commit comments

Comments
 (0)