Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note in readme to guard against NPEs in cyclical states #31

Merged
merged 2 commits into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @synesso @cwmyers @aparkersquare @mmollaverdi @hugomd
* @synesso @cwmyers @aparkersquare @mmollaverdi @hugomd @rgrnwd
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ data object Amber : Color({ setOf(Red) })
data object Red : Color({ setOf(Green) })
```

<aside>
Be sure to define your state constructor with functions rather than literal values if you require cycles in your state
machine. Otherwise, you are likely to encounter null pointer exceptions.
</aside>

### Value

The value is responsible for knowing and updating its current state.
Expand Down
Loading