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.

Sign up for GitHub

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

Jump to bottom

Update docs for StateBox/StateSet: how to construct a new box/set #162

Open
annenkov opened this issue Sep 19, 2022 · 1 comment
Open

Update docs for StateBox/StateSet: how to construct a new box/set #162

annenkov opened this issue Sep 19, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation [Type] Change Request Some visible functionality should be change.

Comments

@annenkov
Copy link
Contributor

annenkov commented Sep 19, 2022 •
edited by Bargsteen
Loading

Description

StateBox and StateSet documentation is missing the details about how to construct them using the StateBuilder. (StateMap has an example that could easily be copied and altered).
@annenkov annenkov added [Type] Change Request Some visible functionality should be change. documentation Improvements or additions to documentation labels Sep 19, 2022
@Bargsteen Bargsteen changed the title Update docs for StateBox: how to construct a new box Update docs for StateBox/StateSet: how to construct a new box/set Sep 21, 2022
@Bargsteen
Copy link
Contributor

Bargsteen commented Sep 21, 2022 •
edited
Loading

I've expanded this to also include StateSet as that is also missing.

This task could also include a simple but more complete use-case example for each state type. Similar to this BTreeMap example, BTreeSet example, and Box example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation [Type] Change Request Some visible functionality should be change.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@annenkov @Bargsteen