Skip to content
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

desc validate #149

Open
olivroy opened this issue May 18, 2024 · 0 comments
Open

desc validate #149

olivroy opened this issue May 18, 2024 · 0 comments

Comments

@olivroy
Copy link

olivroy commented May 18, 2024

Hi, I wonder if it would be possible to implement the desc$validate() method.

I see that when you print a malformed description, it can show as red, but I don't understand the mechanism of how to use that generally.

I wonder if it would be possible to use the check_field() implementation, so that something like this could work out of the box.

desc$validate("Imports")
#> TRUE / FALSE or error?

It could therefore be used elsewhere like in pak or usethis to warn for malformed description.

I used usethis::use_tidy_description() with this as Imports

Imports:
  commonmark
  cli,
  dplyr

And no warning occured. The warning only occured as a pak cryptic error on gh actions, and I was not able to debug myself.

Cf : r-lib/pak#632

I would be happy to open a PR with some guidance.

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

No branches or pull requests

1 participant