Skip to content

New bullet styles for TODOs and questions #781

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jameslairdsmith
Copy link

Fixes #779.

Also touches on the subject matter of the usethis vignette "Converting usethis's UI to use cli" because of the TODOs.

Proposed new syntax:

cli_bullets(c("?" = "This is a question", "[]" = "This is a TODO"))
#> ❓ This is a question
#> ☐ This is a TODO

Some outstanding questions:

  • Do we want to use the fancy question mark instead of the regular one?
  • Is red the correct colour? It felt correct to me for the TODO given that usethis::ui_todo() used red as well.
  • The usethis vignette proposes the underscore "_" as the LHS for TODO instead of "[]". The "[]" feels more natural to me, but it is two characters whereas all the others are one.

Other things.

  • Using roxygen2 (even the development version) seems to be broken for me because of a problem unrelated to the PR. It's in the "cliapp-docs.R".

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.

New bullets
1 participant