Skip to content

Commit

Permalink
Enhance cursor start:/initial: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jmettraux committed Aug 14, 2023
1 parent b498689 commit 834b83c
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions lib/flor/pcore/cursor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ class Flor::Pro::Cursor < Flor::Procedure
#
# ## cursor and start: / initial: attribute
#
# Sometimes, it is necessary to enter a cursor not at its first child, but
# its second or third. Once such a cursor is entered and a `continue` is
# met it will "rewind" to the first child (not the "start" child).
#
# ```
# task 'create mandate'
# cursor start: 'approve mandate'
Expand All @@ -71,6 +75,15 @@ class Flor::Pro::Cursor < Flor::Procedure
# task 'activate mandate'
# ```
#
# The string passed to start:/initial: is looked up (down) in the cursor
# in the order: (example `cursor start: 'bravo'`)
#
# * tag (for example `push l 'b' tag: 'bravo'`)
# * string argument (for example `task 'toto' context: 'bravo'`)
# * string target (for example `task 'bravo'`)
# * name target (for example `bravo _`)
# * att target (for example `task 'toto' bravo: 'ok'`)
#
# ## see also
#
# Break, continue, loop.
Expand Down

0 comments on commit 834b83c

Please sign in to comment.