README: tweaks

Author: HenrikBengtsson

R/progression_handler.R

@@ -290,7 +290,7 @@ print.progression_handler <- function(x, ...) {
   s <- c(s, " * configuration:")
   s <- c(s, sprintf("   - name: %s", sQuote(env$name %||% "<NULL>")))
   s <- c(s, sprintf("   - max_steps: %s", env$max_steps %||% "<NULL>"))
-  s <- c(s, sprintf("   - enable: %g", env$enable))
+  s <- c(s, sprintf("   - enable: %s", env$enable))
   s <- c(s, sprintf("   - enable_after: %g seconds", env$enable_after))
   s <- c(s, sprintf("   - times: %g", env$times))
   s <- c(s, sprintf("   - interval: %g seconds", env$interval))

README.md

@@ -83,11 +83,33 @@ will present itself as sounds played at the beginning, while progressing, and at
 
 It is possible to have multiple progress handlers presenting progress updates at the same time.  For example, to get both visual and auditory updates, use:
 ```r
-options(progressr.handlers = list(txtprogress_barhandler, beepr_handler))
+options(progressr.handlers = list(txtprogressbar_handler, beepr_handler))
+```
+
+
+### Debugging
+
+To debug progress updates, use:
+```r
+> options(progressr.handlers = debug_handler)
+> with_progress(y <- slow_sum(1:10))
+[13:33:50.776] (1.033s => +0.001s) shutdown: 10/10 (+0) '' {clear=TRUE, enabled=TRUE, status=ok}
+[13:33:49.743] (0.000s => +0.002s) initiate: 0/10 (+0) '' {clear=TRUE, enabled=TRUE, status=}
+[13:33:49.847] (0.104s => +0.001s) update: 1/10 (+1) 'Added 1' {clear=TRUE, enabled=TRUE, status=}
+[13:33:49.950] (0.206s => +0.001s) update: 2/10 (+1) 'Added 2' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.052] (0.309s => +0.000s) update: 3/10 (+1) 'Added 3' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.154] (0.411s => +0.001s) update: 4/10 (+1) 'Added 4' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.257] (0.514s => +0.001s) update: 5/10 (+1) 'Added 5' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.361] (0.618s => +0.002s) update: 6/10 (+1) 'Added 6' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.464] (0.721s => +0.001s) update: 7/10 (+1) 'Added 7' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.567] (0.824s => +0.001s) update: 8/10 (+1) 'Added 8' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.670] (0.927s => +0.001s) update: 9/10 (+1) 'Added 9' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.773] (1.030s => +0.001s) update: 10/10 (+1) 'Added 10' {clear=TRUE, enabled=TRUE, status=}
+[13:33:50.774] (1.031s => +0.003s) update: 10/10 (+0) 'Added 10' {clear=TRUE, enabled=TRUE, status=}
 ```
 
 <small>
-(*) To set the default progress presenter in all R session, set this option in your '~/.Rprofile' file.
+(*) To set the default progress presenter in all R session, set this option in your `~/.Rprofile` file.
 </small>