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

Incorrect documentation for State::take_bundle #1709

Closed
prestwich opened this issue Aug 19, 2024 · 0 comments · Fixed by #1711
Closed

Incorrect documentation for State::take_bundle #1709

prestwich opened this issue Aug 19, 2024 · 0 comments · Fixed by #1711

Comments

@prestwich
Copy link
Contributor

/// Takes changeset and reverts from state and replaces it with empty one.
/// This will trop pending Transition and any transitions would be lost.
///
/// NOTE: If either:
/// * The [State] has not been built with [StateBuilder::with_bundle_update], or
/// * The [State] has a [TransitionState] set to `None` when
/// [State::merge_transitions] is called,
///
/// this will panic.

documentation specifies that the function will panic under certain conditions, but the function will not panic even if those conditions are met

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant