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.
Type of changes
Checklist
Here is the pull request description formatted in Markdown:
Description
This PR improves the documentation around usage of the
start()
method in theProgress
class.The changes include:
start()
is required before updatingstart()
for no outputRaising a warning in
__init__
ifstart()
not calledUpdating FAQ with relevant question
This is intended to address #3240 and improve the documentation based on user feedback in #2758
Usage of
start()
was not clearly documented before, which led to confusion when the display did not update. These updates should clarify the requirement and guide users to callstart()
.