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 state.state_update documentation and refactor #307

Open
jwaa opened this issue Sep 27, 2021 · 0 comments
Open

Add state.state_update documentation and refactor #307

jwaa opened this issue Sep 27, 2021 · 0 comments
Labels
core Work related to the core functionality request A request for a new feature

Comments

@jwaa
Copy link
Member

jwaa commented Sep 27, 2021

Is your feature request related to a problem? Please describe.
The State.state_update method is not documented, and the naming is confusing. Does this mean that the state is updated? Does it return some updated version of the state? Or can one use it to update the state?

Describe the solution you would like
Add the documentation of this method and refactor it to something as State.update_entire_state_with_dict.

Describe alternatives you have considered
N/A

Additional context
Found in the WP3 Multi-Team RVO HAT project.

@jwaa jwaa added core Work related to the core functionality request A request for a new feature labels Sep 27, 2021
@jwaa jwaa added this to the Release V2.2.0 milestone Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Work related to the core functionality request A request for a new feature
Projects
None yet
Development

No branches or pull requests

1 participant