Skip to content

Commit

Permalink
Correct typos, ci skip
Browse files Browse the repository at this point in the history
  • Loading branch information
jmettraux committed Aug 17, 2024
1 parent 4d68fcd commit d4d6096
Show file tree
Hide file tree
Showing 42 changed files with 74 additions and 71 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Using flor in your Ruby project requires you to clearly separate business proces

## quickstart

This quickstart sets up a flor unit tied to a SQLite database, resets the databse, binds two taskers and then launches a flow execution involving the two taskers. Finally, it prints out the resulting workitem as the execution has just terminated.
This quickstart sets up a flor unit tied to a SQLite database, resets the database, binds two taskers and then launches a flow execution involving the two taskers. Finally, it prints out the resulting workitem as the execution has just terminated.

```ruby
require 'flor/unit'
Expand Down Expand Up @@ -94,7 +94,7 @@ p r['payload']['log']

This quickstart is at [doc/quickstart0/](doc/quickstart0/), it's a minimal, one-file Ruby quickstart.

There is also [doc/quickstart1/](doc/quickstart1/), a more complex example, that shows a flor setup, where taskers and flows are layed out in a flor directory tree.
There is also [doc/quickstart1/](doc/quickstart1/), a more complex example, that shows a flor setup, where taskers and flows are laid out in a flor directory tree.


## documentation
Expand Down
12 changes: 6 additions & 6 deletions doc/common_attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Attributes shared by all the procedures.

## vars:

Vanilla procedures don't have variables set at their level. The `vars` attribute sets a vanilla hash in the targetted procedure.
Vanilla procedures don't have variables set at their level. The `vars` attribute sets a vanilla hash in the targeted procedure.


## vars: hash
Expand Down Expand Up @@ -46,7 +46,7 @@ sequence vars: { a_0: 'a', a_1: 'A', a_z: 'z', b_0: 'b' }
# only a_0 and a_1 are visible
```

If the first element of the array is "-", "^" or "!", the array is a blacklist. The var names explicitely listed are bound to nil values (shadowing the value in the parent node).
If the first element of the array is "-", "^" or "!", the array is a blacklist. The var names explicitly listed are bound to nil values (shadowing the value in the parent node).

An array beginning with a "+" is a whitelist.

Expand Down Expand Up @@ -109,7 +109,7 @@ The tag attribute sets one or more tags on a node. The tag can be used with the

Read more on [tags](tags.md).

Read also about [sequence](procedures/sequence.md), it can implicitely enter into a tag:
Read also about [sequence](procedures/sequence.md), it can implicitly enter into a tag:
```
sequence 'second phase' # <-- equivalent to sequence tag: 'second phase'
doug _
Expand Down Expand Up @@ -180,7 +180,7 @@ sequence
david 'perform task d'
```

Alice and Bob have 60 to peform their tasks (they're probably automated) while Charly has 2 days and 12 hours. David has no time constraint.
Alice and Bob have 60 to perform their tasks (they're probably automated) while Charly has 2 days and 12 hours. David has no time constraint.

When a timeout triggers, the subtree rooted in the node with the timeout: attribute gets cancelled

Expand All @@ -204,7 +204,7 @@ Read more at [on_timeout](on_timeout.md).

## flank:

Explicitely flags a procedure as "flanking".
Explicitly flags a procedure as "flanking".

In this sample, the `a; b` sequence happens in parallel to the `c; d` parent sequence. As soon as `d` replies to its parent sequence, the flanking child will get cancelled.

Expand Down Expand Up @@ -240,7 +240,7 @@ sequence
set a 2 disabled
```

Please note that the stopping of the node occurs right after the evaluation of the off/disable/disabled, not upon initial evalution of the node. So
Please note that the stopping of the node occurs right after the evaluation of the off/disable/disabled, not upon initial evaluation of the node. So
```
sequence
set d true
Expand Down
2 changes: 1 addition & 1 deletion doc/fragments.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Fragments of documentation that will be reused later on.

##### setting FLOR_DEBUG

This is a targetted run of a spec file:
This is a targeted run of a spec file:
```
FLOR_DEBUG=msg,err bundle exec rspec spec/punit/cancel_spec.rb
```
Expand Down
6 changes: 3 additions & 3 deletions doc/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ TODO

## execution

An execution is an instance of a flow or in other words a live occurence of a process/workflow. It's identified by an [execution id](#exid) ([exid](#exid)).
An execution is an instance of a flow or in other words a live occurrence of a process/workflow. It's identified by an [execution id](#exid) ([exid](#exid)).

## executor

Expand Down Expand Up @@ -120,7 +120,7 @@ is equivalent to:
define f x
x * 3
```
("def" sets the reference of the new fucntion in f.ret, it gets picked by "set" and placed in the variable 'f')
("def" sets the reference of the new function in f.ret, it gets picked by "set" and placed in the variable 'f')

Flor wants [functions](#function), [procedures](#procedure), and [taskers](#tasker) calls to look similar. A single way to call.

Expand Down Expand Up @@ -203,7 +203,7 @@ Or "node id".

A key for the node in its execution. Is of the form `/^\d+(_\d+)*$/`, the root node having the "0" nid.

A nid is implicitely suffixed with `-0`. Nids with a `-\d+` suffix may appear for loops and [branches](#branch) executing multiple times.
A nid is implicitly suffixed with `-0`. Nids with a `-\d+` suffix may appear for loops and [branches](#branch) executing multiple times.

See [subnid](#subnid).

Expand Down
2 changes: 1 addition & 1 deletion doc/launching.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ When given an array of strings, the `#launch` will wait for each string to happe
* `wait: [ '0_0 task', '0_1 task' ]` - same as right above
* `wait: '0_0 execute'` - wait for the execution to reach node 0_0
* `wait: '0_0 receive'` - wait for the first receive message handed to 0_0
* `wait: 'end'` - wait for an execution to pause (usually an execution runs for 77 messages before pausing and yielding for other executions to run, it might alos "end" when sleeping or waiting for external messages)
* `wait: 'end'` - wait for an execution to pause (usually an execution runs for 77 messages before pausing and yielding for other executions to run, it might also "end" when sleeping or waiting for external messages)
* `wait: 'terminated'` - wait until the execution terminates (useful for testing or when using small flows without human participants)
* `wait: 'failed'` - wait until the execution emits a failed message (mostly useful when testing a flow)
* `wait: 'entered'` - wait until the execution enters a tagged branch
Expand Down
6 changes: 3 additions & 3 deletions doc/patterns__control_flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The [case](procedures/case.md) and [match](procedures/match.md) are the other tw
[wp/explanation](http://www.workflowpatterns.com/patterns/control/basic/wcp4.php) | [wp/animation](http://www.workflowpatterns.com/patterns/control/basic/wcp4_animation.php) | [top](#top)

### Simple Merge
<a id="bcf-simple-merge" />A simple merge occur when two (or more) exclusive branch converge. As seen in exclusive choice this pattern is implicitely supported. It simply occurs when the ‘then’ or the ‘else’ clause of an [if](procedures/if.md) terminates and the flow resumes.
<a id="bcf-simple-merge" />A simple merge occur when two (or more) exclusive branch converge. As seen in exclusive choice this pattern is implicitly supported. It simply occurs when the ‘then’ or the ‘else’ clause of an [if](procedures/if.md) terminates and the flow resumes.

[wp/explanation](http://www.workflowpatterns.com/patterns/control/basic/wcp5.php) | [wp/animation](http://www.workflowpatterns.com/patterns/control/basic/wcp5_animation.php) | [top](#top)

Expand Down Expand Up @@ -182,7 +182,7 @@ sequence
task "transfer-patient"
# ...
```
The [concurrence](procedures/concurrence.md) procedure, by default, waits for all its children to respond before ending and replying to its parent procedure (here a [sequence](procecures/sequence.md). The sequence then hands the flow to the `task "transfer-patient"` followup.
The [concurrence](procedures/concurrence.md) procedure, by default, waits for all its children to respond before ending and replying to its parent procedure (here a [sequence](procedures/sequence.md). The sequence then hands the flow to the `task "transfer-patient"` followup.

[wp/explanation](http://www.workflowpatterns.com/patterns/control/advanced_branching/wcp7.php) | [wp/animation](http://www.workflowpatterns.com/patterns/control/advanced_branching/wcp7_animation.php) | [top](#top)

Expand Down Expand Up @@ -276,7 +276,7 @@ sequence

The [concurrence](procedures/concurrence.md) expects one reply and then cancels the remaining branches.

Here is a varient using [c-each](procedures/c_each.md):
Here is a variant using [c-each](procedures/c_each.md):

```python
sequence
Expand Down
6 changes: 3 additions & 3 deletions doc/procedures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* [do-return](do_return.md) - Takes a set of arguments and returns a function that will return those arguments again.
* [each](each.md) - Each is a simplified version of [for-each](for_each.md).
* [empty?](empty.md) - Returns true if the given collection or string is empty.
* [fail, error](fail.md) - Explicitely raises an error.
* [fail, error](fail.md) - Explicitly raises an error.
* [filter, filter-out](filter.md) - Filters a collection
* [find](find.md) - Finds the first matching element.
* [flatten](flatten.md) - Flattens the given array
Expand Down Expand Up @@ -61,7 +61,7 @@
* [timestamp, ltimestamp](timestamp.md) - Places a string timestamp in f.ret.
* [to-array, to-object](to_array.md) - Turns the argument into an array or an object.
* [type-of, type](type_of.md) - returns the type of argument or the incoming f.ret.
* [until, while](until.md) - Loops until or while a condiation evalutates to true.
* [until, while](until.md) - Loops until or while a condiation evaluates to true.

## unit

Expand All @@ -78,7 +78,7 @@
* [graft, import](graft.md) - Graft a subtree into the current execution.
* [on_timeout](on_timeout.md) - Counterpart to the on_timeout: attribute.
* [schedule](schedule.md) - Schedules a function in time.
* [signal](signal.md) - Used in conjuction with "on".
* [signal](signal.md) - Used in conjunction with "on".
* [sleep](sleep.md) - Makes a branch of an execution sleep for a while.
* [task](task.md) - Tasks a tasker with a task.
* [trap](trap.md) - Watches the messages emitted in the execution and reacts when a message matches certain criteria.
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/andor.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ as one of them returns a trueish value. Returns false else.
and
false
true
# => evalutes to false
# => evaluates to false
```

```
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sequence
apply sum 1 2
```

It is usually used implicitely, as in
It is usually used implicitly, as in
```
sequence
define sum a b
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/case.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ case 'ovomolzin'

### defaulting to f.ret

When nothing is explicitely provided for consideration by "case", the
When nothing is explicitly provided for consideration by "case", the
incoming `f.ret` is used.

```
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/fail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# fail, error

Explicitely raises an error.
Explicitly raises an error.

```
fail "not enough water in the tank"
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/match.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ match

## "bind"

"bind" binds explicitely a value and allows for a sub-pattern.
"bind" binds explicitly a value and allows for a sub-pattern.
```
match [ 1 4 ]
[ 1 (bind y (or 2 3)) ]; "match y:$(y)"
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/reverse.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Reverses f.ret if there are no arguments
reverse _ # sets f.ret to [ 4, 6, 5 ]
```

Will fail if it finds nothing reversable.
Will fail if it finds nothing reversible.

# see also

Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/set.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ sequence
set __2 g h
[ 9 10 11 12 13 ]
# ==> g: 11, h: 12
# `__` is not prefixed by a var name, so it justs discard
# `__` is not prefixed by a var name, so it just discards
# what it captures
set i j___
[ 14 15 16 17 18 19 ]
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/signal.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# signal

Used in conjuction with "on".
Used in conjunction with "on".

An external (or internal) agent may send a signal to an execution and the
execution may have a "on" handler for it.
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/trap.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Please note how "on" accepts a block while "trap" accepts a function.

The range limit determines what is the range, or scope of the trap.
By default the trap only care about nodes below its parent. In other words,
the trap binds itself to its parent and observes the messages occuring
the trap binds itself to its parent and observes the messages occurring
in the execution in the branch of nodes whose root is the parent.

The possible values for `range:` are:
Expand Down
2 changes: 1 addition & 1 deletion doc/procedures/until.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# until, while

Loops until or while a condiation evalutates to true.
Loops until or while a condiation evaluates to true.

```
set i 0
Expand Down
2 changes: 1 addition & 1 deletion doc/services/loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Here is an example tree:
│   │   └── team_b # the com/example/team_b tasker
│   │   ├── dot.json
│   │   └── tasker.rb
│   └── com.example.accounting.json # taskers for com/example/accouting
│   └── com.example.accounting.json # taskers for com/example/accounting
├── usr
│   └── com.example.sales
│   └── co
Expand Down
2 changes: 1 addition & 1 deletion doc/services/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

* logger - currently bicephalous, the hooker hands it all messages for logging (will do nothing unless in debug mode) and receives log/info/warn/error calls and logs them

(I should proably split this logger in two)
(I should probably split this logger in two)

* wait list - a small service only relevant in spec/tests, lets Ruby code wait until an message is seen in flor

Expand Down
2 changes: 1 addition & 1 deletion doc/strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Adding a string to a number yields an error.
+ 1 "lo" # fails...
```

If the first operand to a `+` is a string, then all subsquent operands are turned into strings and the result is the concatenation of all the strings.
If the first operand to a `+` is a string, then all subsequent operands are turned into strings and the result is the concatenation of all the strings.
```
+ '' 1 true [ 1 2 ] # yields "1true[1, 2]"
```
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/core/executor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ def make_node(message)
end
#
# vars: variables
# vdomain: variable domain (used in conjuction with the loader)
# vdomain: variable domain (used in conjunction with the loader)
# cnid: closure nid
# dbg: used to debug messages (useful @node['dbg'] when 'receive')

Expand Down
6 changes: 3 additions & 3 deletions lib/flor/core/procedure.rb
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ def do_wrap_cancel_children(h={})
end

# Called by the executor, in turns call cancel and cancel_when_ methods
# which may be overriden.
# which may be overridden.
#
def do_cancel

Expand Down Expand Up @@ -908,7 +908,7 @@ def do_cancel
end

# Called by the executor, in turns call kill and kill_when_ methods
# which may be overriden.
# which may be overridden.
#
def do_kill

Expand Down Expand Up @@ -941,7 +941,7 @@ def kill_when_ended
[] # no effect
end

# The core cancel work, is overriden by some procedure implementations.
# The core cancel work, is overridden by some procedure implementations.
#
def cancel

Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/andor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Flor::Pro::Andor < Flor::Procedure
# and
# false
# true
# # => evalutes to false
# # => evaluates to false
# ```
#
# ```
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/apply.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class Flor::Pro::Apply < Flor::Procedure
# apply sum 1 2
# ```
#
# It is usually used implicitely, as in
# It is usually used implicitly, as in
# ```
# sequence
# define sum a b
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/case.rb
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class Flor::Pro::Case < Flor::Procedure
#
# ### defaulting to f.ret
#
# When nothing is explicitely provided for consideration by "case", the
# When nothing is explicitly provided for consideration by "case", the
# incoming `f.ret` is used.
#
# ```
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/define.rb
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def flatten_tree

return [ tre, sig ] unless wrapped?(sig)

# There is a parenthese around the parameters, let's unwrap that...
# There are parentheses around the parameters, let's unwrap that...

hed = Flor.dup(tre[1][0, off])
sig = Flor.dup(sig)
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/fail.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

class Flor::Pro::Fail < Flor::Procedure
#
# Explicitely raises an error.
# Explicitly raises an error.
#
# ```
# fail "not enough water in the tank"
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/match.rb
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ class Flor::Pro::Match < Flor::Pro::Case
#
# ## "bind"
#
# "bind" binds explicitely a value and allows for a sub-pattern.
# "bind" binds explicitly a value and allows for a sub-pattern.
# ```
# match [ 1 4 ]
# [ 1 (bind y (or 2 3)) ]; "match y:$(y)"
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/reverse.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Flor::Pro::Reverse < Flor::Procedure
# reverse _ # sets f.ret to [ 4, 6, 5 ]
# ```
#
# Will fail if it finds nothing reversable.
# Will fail if it finds nothing reversible.
#
# # see also
#
Expand Down
2 changes: 1 addition & 1 deletion lib/flor/pcore/set.rb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class Flor::Pro::Set < Flor::Procedure
# set __2 g h
# [ 9 10 11 12 13 ]
# # ==> g: 11, h: 12
# # `__` is not prefixed by a var name, so it justs discard
# # `__` is not prefixed by a var name, so it just discards
# # what it captures
# set i j___
# [ 14 15 16 17 18 19 ]
Expand Down
Loading

0 comments on commit d4d6096

Please sign in to comment.