-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Document new ProgressBar time-based frequency mutators #12364
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
Merged
Merged
Conversation
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
OskarStark
reviewed
Sep 25, 2019
09b195a
to
8a5b08d
Compare
Gabriel, thanks for contributing these docs! And congrats on your first Symfony Docs contribution. |
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Nov 4, 2019
…ncy (javiereguiluz) This PR was squashed before being merged into the 4.4 branch (closes #33732). Discussion ---------- [Console] Rename some methods related to redraw frequency | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - In #26339 we added `preventRedrawFasterThan()` and `forceRedrawSlowerThan()`. While merging the docs for them (symfony/symfony-docs#12364) I thought that the method names are a bit hard to understand. In this PR I propose a renaming for your consideration. Thanks! In the following example, we want to update the progress bar every 100 iterations, but not faster than 100ms or slower than 200ms. **Before** ```php $progressBar = new ProgressBar($output, 50000); $progressBar->start(); $progressBar->setRedrawFrequency(100); $progressBar->preventRedrawFasterThan(0.1); $progressBar->forceRedrawSlowerThan(0.2); ``` **After** ```php $progressBar = new ProgressBar($output, 50000); $progressBar->start(); $progressBar->setRedrawFrequency(100); $progressBar->maxRefreshInterval(0.1); $progressBar->minRefreshInterval(0.2); ``` Commits ------- e6ee7b0 [Console] Rename some methods related to redraw frequency
symfony-splitter
pushed a commit
to symfony/console
that referenced
this pull request
Nov 4, 2019
…ncy (javiereguiluz) This PR was squashed before being merged into the 4.4 branch (closes #33732). Discussion ---------- [Console] Rename some methods related to redraw frequency | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - In #26339 we added `preventRedrawFasterThan()` and `forceRedrawSlowerThan()`. While merging the docs for them (symfony/symfony-docs#12364) I thought that the method names are a bit hard to understand. In this PR I propose a renaming for your consideration. Thanks! In the following example, we want to update the progress bar every 100 iterations, but not faster than 100ms or slower than 200ms. **Before** ```php $progressBar = new ProgressBar($output, 50000); $progressBar->start(); $progressBar->setRedrawFrequency(100); $progressBar->preventRedrawFasterThan(0.1); $progressBar->forceRedrawSlowerThan(0.2); ``` **After** ```php $progressBar = new ProgressBar($output, 50000); $progressBar->start(); $progressBar->setRedrawFrequency(100); $progressBar->maxRefreshInterval(0.1); $progressBar->minRefreshInterval(0.2); ``` Commits ------- e6ee7b07f3 [Console] Rename some methods related to redraw frequency
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.
Fixes #11915