Correct documentation of show_progress (no longer utils::txtProgressBar) #2762
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
AshesITR
approved these changes
Feb 19, 2025
| #' progress bar _via_ [utils::txtProgressBar()]. The default behavior is to show progress in | ||
| #' [interactive()] sessions not running a testthat suite. | ||
| #' @param show_progress Logical controlling whether to show linting progress with | ||
| #' [cli::cli_progress_along()]. The default behavior is to show progress in [interactive()] sessions |
There was a problem hiding this comment.
My 2 cents: Including such implementation details in user-facing documentation is not a good idea. The users care about showing or displaying the progress bar, not how we decided to implement it.
There was a problem hiding this comment.
It's a fair point, and this PR proves it's easy to get out of sync with the implementation.
OTOH, it could wind up in the API if we want to expose some flexibility to the display.
I'm also not familiar with {cli}, but there could be some options() that affect the display -- knowing which {cli} function is used can tell them which options are relevant.
So I'm a bit indifferent -- if you're motivated to change, I'll approve the PR.
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.
No description provided.