search

ropensci / dev_guide

rOpenSci Packages: Development, Maintenance, and Peer Review
https://devguide.ropensci.org
Creative Commons Attribution Share Alike 4.0 International
159 stars 54 forks source link

add another link about "cli" #795

Closed maelle closed 6 months ago

maelle commented 6 months ago

Via @peterdesmet in https://github.com/ropensci/dev_guide/pull/765#discussion_r1446070465

peterdesmet commented 6 months ago

Sounds good not to merge it, but I would like a bit more guidance for package developers. Especially the combination of CLI (advised) and silencing. In other words, if you use CLI, how can users (and you in tests) silence messages?

mpadge commented 6 months ago

Great point @peterdesmet. I agree that we need something, so should now modify this PR to remove usethis link, which i don't think helps, and replace with something better. Feel free to modify PR if you have any great suggestions.

peterdesmet commented 6 months ago

Feel free to modify PR if you have any great suggestions.

I don't 😄 I've just started with cli, so don't know what is supported out of the box regarding silencing.

maelle commented 6 months ago

Does https://blog.r-hub.io/2023/11/30/cliff-notes-about-cli/#how-to-make-cli-quiet-or-not help at all? That's all I know about silencing it. That, plus creating wrappers in a package that respond to a package-level option (like usethis.quiet).

mpadge commented 6 months ago

I'd say almost, but not quite. I guess there's now a rather urgent need for us to draft a tech note explaining this and only this. We can then use that as the reference.