Correct Progress example in README#505
Merged
43081j merged 1 commit intobombshell-dev:mainfrom Apr 3, 2026
Merged
Conversation
The progress example used `progress.advance` as if it was setting the progress amount - in fact, it advances the progress amount forward by the given amount. This small correction I hope will make this distinction more obvious, as it tripped me up just now.
|
43081j
approved these changes
Apr 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The progress example used
progress.advanceas if it was setting the progress amount. When in fact, it advances the progress amount forward by the given amount. This small correction I hope will make this distinction more obvious to future readers.