Skip to content

Commit

Permalink
Update general_issues.qmd
Browse files Browse the repository at this point in the history
  • Loading branch information
Baltmann01 authored Nov 15, 2024
1 parent 6bb0969 commit 3191111
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions general_issues.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ format:
<!-- I would add a section about the path of packages when they are submitted to CRAN.
Where do they end up and who will look at them etc... -->

# Fields of the DESCRIPTION File
<!-- # Fields of the DESCRIPTION File -->

<!-- I suggest writing a short overview of the most common and important fields of the DESCRIPTION -->

## 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.

Expand Down

0 comments on commit 3191111

Please sign in to comment.