Skip to content

docs: document cli_progress_sleep() in C API reference #829

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.

Sign up for GitHub

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

Closed
LeonidasZhak wants to merge 1 commit into from
Closed

docs: document cli_progress_sleep() in C API reference #829

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions inst/include/cli/progress.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,22 @@ static R_INLINE void cli_progress_set_status(SEXP bar, const char *status);

static R_INLINE void cli_progress_set_type(SEXP bar, const char *type);

//' ### `cli_progress_sleep()`
//'
//' ```c
//' void cli_progress_sleep(int s, long ns);
//' ```
//'
//' Sleep for the specified amount of time. This function is mainly
//' useful in examples and tests, to simulate a computation that takes
//' some time. It respects the `CLI_SPEED_TIME` environment variable,
//' so automated tests can run faster.
//'
//' * `s`: number of seconds to sleep.
//' * `ns`: number of nanoseconds to sleep.

static R_INLINE void cli_progress_sleep(int s, long ns);

//' ### `cli_progress_update()`
//'
//' ```c
Expand Down
Loading