Skip to content

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

Closed
LeonidasZhak wants to merge 1 commit into
r-lib:mainfrom
LeonidasZhak:docs/document-cli-progress-sleep
Closed

docs: document cli_progress_sleep() in C API reference#829
LeonidasZhak wants to merge 1 commit into
r-lib:mainfrom
LeonidasZhak:docs/document-cli-progress-sleep

Conversation

@LeonidasZhak

Copy link
Copy Markdown
Contributor

Fixes #806.

Add roxygen documentation for cli_progress_sleep() in the progress C API header (inst/include/cli/progress.h), matching the style of adjacent entries.

Changes

  • Added documentation block for cli_progress_sleep(int s, long ns) between cli_progress_set_type() and cli_progress_update() entries
  • Documents the function signature, purpose (sleep utility for examples/tests), and CLI_SPEED_TIME environment variable support

Validation

  • Documentation follows the same //' ### func()`` pattern as all other entries in the header
  • No code changes, documentation only
  • 16 lines added to inst/include/cli/progress.h

Fixes #806. Add roxygen documentation for cli_progress_sleep() in the
progress C API header, matching the style of adjacent entries.
@gaborcsardi

Copy link
Copy Markdown
Member

@LeonidasZhak Is this a purely LLM-generated pull request? Please stop opening LLM-generated pull requests on the r-lib and tidyverse repositories for now.

@LeonidasZhak

Copy link
Copy Markdown
Contributor Author

Withdrawing this small automated PR while I consolidate an oversized batch of contributions and reduce maintainer review burden. Sorry for the noise, and thank you for maintaining the project.

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.

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

2 participants