diff --git a/general_issues.qmd b/general_issues.qmd index 6e0c85a..5e5bb24 100644 --- a/general_issues.qmd +++ b/general_issues.qmd @@ -11,11 +11,11 @@ format: -# Fields of the DESCRIPTION File + -## Description Length +# Description Length The description field in the DESCRIPTION file should be a short paragraph (2+ sentences) on the package's purpose, motivation and may include further references to the package documentation website. You can also consider the Description length to be similar to a blurb or synopsis written on the inside jacket of a book - brief but informative. A good example of this description length is included in the ['tidyverse'](https://github.com/tidyverse/tidyverse/blob/main/DESCRIPTION#L8-L12) package.