Skip to content

Commit

Permalink
add note on ivars
Browse files Browse the repository at this point in the history
  • Loading branch information
ezekg committed Aug 14, 2024
1 parent d2c6b68 commit 2ef7ddc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ it 'should transition nowhere' do
end
```

## Note on instance variables

Currently, storing state in an instance variable is not supported. This due to
the fact that instance variables cannot be observed for changes like an
accessor can. For more information, see [the tests](https://github.com/keygen-sh/transition_through/blob/d2c6b685e4959d08e70bb5012af98fa01fcdebef/spec/transition_through_spec.rb#L8-L21).

If you know of a way to support ivars, please open an issue or PR.

## Supported Rubies

**`transition_through` supports Ruby 3.1 and above.** We encourage you to upgrade
Expand Down

0 comments on commit 2ef7ddc

Please sign in to comment.