golem icon indicating copy to clipboard operation
golem copied to clipboard

01_start.R - Change pkg_title comment to "What The Package Does (One Line, Title Case)"

Open durandsinclair opened this issue 4 years ago • 1 comments

The purpose of the comments at the end of lines 16 to 23 is to help the package developer to figure out what to do. But right now, lines 18 and 19 of dev/01_start.R say:

pkg_title = "PKG_TITLE", # The Title of the package containing the App. pkg_description = "PKG_DESC", # The Description of the package containing the App.

As a newbie who isn't sure what to do here, I'd like the comment to direct me how to fill it out. Like this, from Hadley's "R Packages" book, which would be:

pkg_title = "PKG_TITLE", # What The Package Does (One Line, Title Case) pkg_description = "PKG_DESC", # What the package does (One paragraph)

durandsinclair avatar Jan 10 '21 23:01 durandsinclair

I think this is a good point to clarify the documentation.

novica avatar Oct 05 '21 14:10 novica

close via #1021

ColinFay avatar Apr 04 '23 15:04 ColinFay