Skip to content

Commit d98c3ab

Browse files
fahchenclaude
andcommitted
style: format markdown content with dprint formatter
Apply dprint markdown formatting to module documentation, comments, and inline markdown across all source files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent e7d5d81 commit d98c3ab

64 files changed

Lines changed: 271 additions & 198 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

lib/coloured_flow/builder/definition_helper.ex

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,13 @@ defmodule ColouredFlow.Builder.DefinitionHelper do
6868
### Examples
6969
7070
#### Define a place and a transition
71+
7172
```elixir
7273
arc turn_green_ew <~ red_ew :: "bind {1, u}"
7374
```
75+
7476
is equal to the following code:
77+
7578
```elixir
7679
build_arc!(
7780
place: "red_ew",
@@ -82,10 +85,13 @@ defmodule ColouredFlow.Builder.DefinitionHelper do
8285
```
8386
8487
#### Define a transition to a place
88+
8589
```elixir
8690
arc turn_green_ew ~> green_ew :: "{1, u}"
8791
```
92+
8893
is equal to the following code:
94+
8995
```elixir
9096
build_arc!(
9197
place: "green_ew",

lib/coloured_flow/builder/set_action_outputs.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule ColouredFlow.Builder.SetActionOutputs do
22
@moduledoc """
3-
This phase is responsible for setting the outputs of the actions
4-
according to the expressions from arcs and the transition guard.
3+
This phase is responsible for setting the outputs of the actions according to
4+
the expressions from arcs and the transition guard.
55
"""
66

77
alias ColouredFlow.Definition.Action

lib/coloured_flow/definition/action.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
defmodule ColouredFlow.Definition.Action do
22
@moduledoc """
33
An action is an executable program that is executed when a transition is fired.
4-
It's the workitem handler's responsibility to interpret the payload
5-
and update the variables in the outputs.
4+
It's the workitem handler's responsibility to interpret the payload and update
5+
the variables in the outputs.
66
77
ref: <https://cpntools.org/2018/01/09/code-segments/>
88
"""

lib/coloured_flow/definition/arc.ex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ defmodule ColouredFlow.Definition.Arc do
33
An arc is a directed connection between a transition and a place.
44
55
> #### TIP {: .tip}
6+
>
67
> Note that the terms `incoming` and `outgoing` are relevant to the transition.
7-
> If the arc is linked from a place such that the orientation is `:p_to_t`,
8-
> it is considered an incoming arc; otherwise, it is considered an outgoing arc.
8+
> If the arc is linked from a place such that the orientation is `:p_to_t`, it
9+
> is considered an incoming arc; otherwise, it is considered an outgoing arc.
910
"""
1011

1112
use TypedStructor

lib/coloured_flow/definition/colour_set.ex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ defmodule ColouredFlow.Definition.ColourSet do
1414
@typedoc """
1515
The value should be a literal quoted expression.
1616
17-
`Macro.quoted_literal?/1` can be used to check if a quoted expression is a literal.
17+
`Macro.quoted_literal?/1` can be used to check if a quoted expression is a
18+
literal.
1819
1920
## Valid examples:
2021

lib/coloured_flow/definition/constant.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule ColouredFlow.Definition.Constant do
22
@moduledoc """
3-
A constant is a named value that can never be changed,
4-
can be used in expressions.
3+
A constant is a named value that can never be changed, can be used in
4+
expressions.
55
66
## Examples
77

lib/coloured_flow/definition/place.ex

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
defmodule ColouredFlow.Definition.Place do
22
@moduledoc """
3-
A place is a location in the petri net where tokens can be
4-
stored.
3+
A place is a location in the petri net where tokens can be stored.
54
"""
65

76
use TypedStructor

lib/coloured_flow/definition/presentation/presentation.ex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ defmodule ColouredFlow.Definition.Presentation do
1313
@indent " "
1414

1515
@doc """
16-
Generate a [mermaid](https://mermaid.js.org/) representation of the coloured petri net.
16+
Generate a [mermaid](https://mermaid.js.org/) representation of the coloured
17+
petri net.
1718
"""
1819
@spec to_mermaid(ColouredPetriNet.t()) :: String.t()
1920
def to_mermaid(%ColouredPetriNet{} = cpnet) do

lib/coloured_flow/definition/procedure.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule ColouredFlow.Definition.Procedure do
22
@moduledoc """
3-
A procedure(aka function, renamed to avoid conflict with Elixir's function)
4-
is a named function, that can be used in expressions.
3+
A procedure(aka function, renamed to avoid conflict with Elixir's function) is a
4+
named function, that can be used in expressions.
55
"""
66

77
use TypedStructor

lib/coloured_flow/definition/termination_criteria/markings.ex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
defmodule ColouredFlow.Definition.TerminationCriteria.Markings do
22
@moduledoc """
3-
The termination criteria applied to place markings. If the criteria are satisfied,
4-
the corresponding enactment will be terminated, and the reason will be `explicit`.
3+
The termination criteria applied to place markings. If the criteria are
4+
satisfied, the corresponding enactment will be terminated, and the reason will
5+
be `explicit`.
56
"""
67

78
use TypedStructor

0 commit comments

Comments
 (0)