Skip to content

Commit

Permalink
[#186700408] UPDATE README: Add note for prefix-option
Browse files Browse the repository at this point in the history
  • Loading branch information
EisenMax committed Jun 19, 2024
1 parent e005d0b commit 006df40
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ state_machine :review_state, prefix: 'some_prefix' do
end
```

Note: The `prefix` option is designed to apply only to constants and state methods **defined by the gem**.

**State event names** are manually defined by the developer and thus not altered even if the `prefix`
option is used. It's advised to review them regarding potential naming collision and clarity when
introducing the `prefix` method.

## Taking multiple transitions

Expand Down

0 comments on commit 006df40

Please sign in to comment.