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

Provide more context in BundleState docs #1332

Open
onbjerg opened this issue Apr 18, 2024 · 0 comments
Open

Provide more context in BundleState docs #1332

onbjerg opened this issue Apr 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@onbjerg
Copy link
Collaborator

onbjerg commented Apr 18, 2024

The docs for BundleState start with a sentence that assumes the reader has more context than they might:

/// Bundle state contain only values that got changed

It is not necessarily clear what is meant by "changed values"

Additionally, the docs mention reverts a couple of times, but never really explain what they are, so a user might be unsure of what to provide as a value for e.g. revert_range in BundleState::builder or for reverts in BundleState::new

@onbjerg onbjerg added the documentation Improvements or additions to documentation label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant