Skip to content

Add state.state_update documentation and refactor #307

@jwaa

Description

@jwaa

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreWork related to the core functionalityrequestA request for a new feature

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions