usethis icon indicating copy to clipboard operation
usethis copied to clipboard

Changes to default package doc template

Open hadley opened this issue 3 years ago • 2 comments

  • Drop @keywords internal
  • Add @includeRmd ../README.md (or whatever the correct path is)

This would provide a convenient way to access the README from within the package — it looks the package doc itself is listed at the top of (e.g.) help(package = rtweet)

hadley avatar Feb 21 '21 15:02 hadley

Hmmm, tried this with usethis itself — the correct path is @includeRmd README.md but then I get

Updating usethis documentation
ℹ Loading usethis
File man/figures/logo.png not found in resource path
Error: pandoc document conversion failed with error 99
Execution halted

So some path isn't set correctly

hadley avatar Feb 21 '21 15:02 hadley

Add @includeRmd ../README.md (or whatever the correct path is)

Ooh, this is an interesting idea!

jennybc avatar Feb 21 '21 16:02 jennybc

I'm no longer convinced that this is worthwhile.

hadley avatar Jan 19 '23 20:01 hadley