C function cli_progress_sleep() is used in an example but not documented.

Open Beginner friendly
#806 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
r
Domain
documentation

Research direction

Open vignette/progress-advanced.Rmd at lines 462-473 and inspect how cli_progress_sleep() is used in the example. Clarify whether it is a placeholder for computation or serves another purpose; the example is done when a reader can understand the function's role.

Written by the indexing model from the issue text.

Description

In the following example, it's not clear what it does; is it meant to be a placeholder for the actual computation, or does it serve a function?
https://github.com/r-lib/cli/blob/3dd94c02b25f6ab02748648a943dce73fa2e17c6/vignettes/progress-advanced.Rmd#L462-L473

Dominant language
R
Stars
726
Forks
94
Avg merge
3h 35m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from r-lib/cli

All issues in r-lib/cli

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.