Skip to content

Commit 45a0bbf

Browse files
authored
Merge pull request #75 from r-devel/Desc_length_update
Change the example for the "Description Length"-Issue
2 parents 5f99ed1 + ad3d8d2 commit 45a0bbf

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

general_issues.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Where do they end up and who will look at them etc... -->
1717

1818
# Description Length
1919

20-
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.
20+
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 ['ranger'](https://github.com/imbs-hl/ranger/blob/af66626cbe5eadcc4cdf6cc3daeb74e9d90b204f/DESCRIPTION#L10-L15) package.
2121

2222
::: {.callout-note title="CRAN Review Communication" appearance="simple" icon=false collapse=true}
2323

0 commit comments

Comments
 (0)