Skip to content

Commit 3dc1ce0

Browse files
committed
Update README
1 parent 9bf3f32 commit 3dc1ce0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ An implementation of a Command pattern, which is callable, and can be partially
44

55
Inputs to the operation are specified as typed attributes (uses [`literal`](https://github.com/joeldrapper/literal)).
66

7-
Type of result of the operation is up to you, eg you could use [`literal` monads](https://github.com/joeldrapper/literal) or [`Dry::Monads`](https://dry-rb.org/gems/dry-monads/1.3/).
7+
Type of result of the operation is up to you, eg you could use [`Dry::Monads`](https://dry-rb.org/gems/dry-monads/1.3/).
88

99
## Features
1010

@@ -170,8 +170,10 @@ Create an operation by subclassing `TypedOperation::Base` or `TypedOperation::Im
170170

171171
- `TypedOperation::Base` (uses `Literal::Struct`) is the parent class for an operation where the arguments are potentially mutable (ie not frozen).
172172
No attribute writer methods are defined, so the arguments can not be changed after initialization, but the values passed in are not guaranteed to be frozen.
173-
- `TypedOperation::ImmutableBase` (uses `Literal::Data`) is the parent class for an operation where the arguments are immutable (frozen on initialization),
174-
thus giving a somewhat stronger immutability guarantee (ie that the operation does not mutate its arguments).
173+
- `TypedOperation::ImmutableBase` (uses `Literal::Data`) is the parent class for an operation where the operation instance is frozen on initialization,
174+
thus giving a somewhat stronger immutability guarantee.
175+
176+
> Note: you cannot include `TypedOperation::ActionPolicyAuth` into a `TypedOperation::ImmutableBase`.
175177
176178
The subclass must implement the `#perform` method which is where the operations main work is done.
177179

0 commit comments

Comments
 (0)