Skip to content

Document progress bar completion messages#826

Merged
gaborcsardi merged 2 commits into
r-lib:mainfrom
LeonidasZhak:codex/document-progress-completion-message
Jun 5, 2026
Merged

Document progress bar completion messages#826
gaborcsardi merged 2 commits into
r-lib:mainfrom
LeonidasZhak:codex/document-progress-completion-message

Conversation

@LeonidasZhak

Copy link
Copy Markdown
Contributor

Fixes #610.

This updates the cli_progress_bar() documentation to show how to leave a final success or failure message on screen with clear = FALSE, format_done, and format_failed, including an example that reports pb_elapsed.

Checks:

  • Rscript -e 'tools::checkRd("man/cli_progress_bar.Rd")'\n- git diff --check\n- R CMD build --no-build-vignettes .\n- R_LIBS_USER=/tmp/cli-r-lib _R_CHECK_FORCE_SUGGESTS_=false R CMD check --no-manual --ignore-vignettes --no-build-vignettes --no-tests cli_3.6.6.9000.tar.gz

@gaborcsardi

Copy link
Copy Markdown
Member

Thank you!

@gaborcsardi gaborcsardi merged commit 86bdefe into r-lib:main Jun 5, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documenting progress bar pattern with completion message

2 participants