adding optional msg parameter to \cli\Progress\Bar::tick()#126
Merged
schlessera merged 3 commits intowp-cli:masterfrom Mar 12, 2018
Merged
adding optional msg parameter to \cli\Progress\Bar::tick()#126schlessera merged 3 commits intowp-cli:masterfrom
schlessera merged 3 commits intowp-cli:masterfrom
Conversation
schlessera
approved these changes
Mar 12, 2018
Member
|
Thanks for the pull request! |
Contributor
Author
|
Thanks for your involvement, @schlessera. This probably calls for updating the progress bar documentation as well. Appreciate the collaboration! |
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.
As discussed in #125
The tick method of
\cli\Notify::tick()is augmented in its grandchild class,\cli\Progress\Barto have an optional second parameter which updates its_messageproperty. As items are processed, the message may be optionally changed to reflect the nature of the work being performed.The current behavior of the progress bar suppresses any output until the first tick occurs. In use cases where the developer wishes to display the initial message and then alter it during the first tick, they should manually call the public
display()method of the progress bar before work is performed and the tick occurs.The use case of displaying a message describing work about to be performed would be better served by supplementing this updated
tick()method with a setter for the_messageproperty whereby the message is manually changed before work is performed, then the tick is used to increment progress separately.