Tweak progress bar docs. #3286
Merged
Tweak progress bar docs. #3286
Conversation
This file contains 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
There is no good reason as to why the progress bar can't be set back to its indeterminate state (and you could actually do it with code) so this removes the docstring that says that a progress bar can't go back to its indeterminate state. Related issue: #3268 Related Discord message: https://discord.com/channels/1026214085173461072/1033754296224841768/1149742624002023594
rodrigogiraoserrao
force-pushed
the
progress-bar-docs
branch
from
7c027f5
to
e061f73
Compare
willmcgugan
requested changes
Sep 15, 2023
It's not that it prohibits. It's the only way to design such an |
|
I can get rid of the method |
To comply with #3286 (review) we create a new type around a sentinel object and check whether we're using the sentinel before modifying the progress bar reactives. Things that didn't quite work well: - directly checking 'if parameter is not _sentinel:' won't satisfy type checkers because that condition doesn't restrict the type of 'parameter' to _not_ be 'UnsetParameter'. - checking 'isinstance(parameter, float)' isn't enough because the user may call the method with an integer like '3' and then the isinstance check would fail. - checking 'isinstance(parameter, (int, float))' works but looks a bit odd, plus it is not very general.
willmcgugan
approved these changes
Sep 20, 2023
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There is no good reason as to why the progress bar can't be set back to its indeterminate state (and you could actually do it with code) so this removes the docstring that says that a progress bar can't go back to its indeterminate state.
Related issue: #3268
Related Discord message: https://discord.com/channels/1026214085173461072/1033754296224841768/1149742624002023594
The user in the linked Discord message reports that
pb.update(total=None)“didn't change the [total] value so it doesn't work” but that's howupdateworks:pb.update(progress=None)does nothing; andpb.update(advance=None)also does nothing.The method
updatecan only affect changes for keyword arguments that are set to a value other thanNone.Setting
pb.total = Noneworks (it already worked) and the docstring fortotalno longer says otherwise.I also added a test to make sure that setting
totalback toNoneworks, so now this is explicitly a supported feature.