search

r-devel / cran-cookbook

Problem and solution documentation for common CRAN issues
http://contributor.r-project.org/cran-cookbook/
42 stars 1 forks source link

Description file: Description Length #39

Closed jasdumas closed 1 week ago

jasdumas commented 2 weeks ago

The description in the DESCRIPTION file should be a short paragraph on what the package is all about (preferably including further references). Sometimes I see descriptions which are only a short sentence or the title of the package repeated. We would like description texts to be CRAN package equivalents to cover texts of books or abstracts of papers.

jasdumas commented 2 weeks ago

@Baltmann01 I'm wondering if this issue might make sense in the general section. If a maintainer does this "Sometimes I see descriptions which are only a short sentence or the title of the package repeated." does it result in a warning or NOTE or is it a rejection from CRAN after submission?

Baltmann01 commented 2 weeks ago

There is no automatic NOTE produced as it is difficult to automatically set some form of threshold. Amount of words/sentences does not really make sense there and some packages do not need a very long description (e.g.: API wrappers and such).

I guess we can add a section about the description in the general section and include this issue there.

jasdumas commented 2 weeks ago

Thanks for your input...I'll think a bit more about this too and find an appropriate section to move this to.