r-lib / devtools

Tools to make an R developer's life easier
https://devtools.r-lib.org
Other
2.39k stars 758 forks source link

Change `quiet` default for `build_site()` #2578

Open TimTaylor opened 2 weeks ago

TimTaylor commented 2 weeks ago

I load devtools automatically in my R profile and always check my site rendering with build_site(). By default this wrapper suppresses output (quiet = TRUE). Unfortunately this means you can miss a lot of really useful warning information (particularly the new alt-text warnings that have been added).

As a lot of effort has gone in to the new pkgdown release, in particular the various warnings / information, it seems a shame for this to be hidden. Is it worth considering changing the default to quiet = FALSE?

jennybc commented 2 weeks ago

TBH it's news to me that devtools has a build_site() function! (I inherited this package as a very mature product.)

So as someone who does a lot of package dev and does actually maintain devtools, my local move for this is to use the pkgdown addin or, for more specialized tasks, make pkgdown::build_*() calls in the console. I realize that doesn't totally address your question, but maybe it's interesting to know.

@hadley As pkgdown maintainer and creator of devtools, do you have an opinion here?

Screenshot 2024-08-28 at 2 47 01 PM
hadley commented 2 weeks ago

I think it would be ideal if we could just make this a shortcut for calling pkgdown::build_site() in the console.