search

thijsjanzen / nLTT

Repository for the R nLTT package
GNU General Public License v2.0
6 stars 4 forks source link

CRAN metadata issue #39

Closed thijsjanzen closed 5 years ago

thijsjanzen commented 6 years ago

I just received the following e-mail regarding the nLTT package:

This concerns CRAN packages maintained by one of you, see the long list at the end of this message. These packages document package metadata (specifically, package versions) in their *-package Rd file(s) which have gotten out of sync with the actual package metadata in the DESCRIPTION file.

Most likely, these Rd files were generated by older versions of utils::promptPackage() (maybe via utils::package.skeleton()), which generated package documentation shells/skeletons with copies of the current package metadata. This was not a good idea, as inevitably such copies go out of sync with their master values. The R 3.2.0 release (3 years ago) did

A number of macros have been added in the new 'share/Rd' directory for use in package overview help pages, and promptPackage() now makes use of them.

(so that package documentation shells/skeletons generated with current versions of utils::promptPackage() use Rd macro references to the package metadata values instead of making copies).

Can you please bring package Rd files "up to date"? The simplest may be using a current utils::promptPackage() to re-generate the shell/skeleton, and merge with the content of the current package Rd file. (In case the updated package Rd file would more or less only duplicate the package metadata, feel free to drop the package Rd file from your package sources.)

I don't know which lines or code they are referring to. @richelbilderbeek do you have any idea?

richelbilderbeek commented 6 years ago

Sounds like: