[Rd] Title case in DESCRIPTION for package where a word is a function name
bbolker at gmail.com
Sat Apr 25 01:13:15 CEST 2015
Uwe Ligges <ligges <at> statistik.tu-dortmund.de> writes:
> On 24.04.2015 22:44, Ben Bolker wrote:
> > Prof J C Nash (U30A <nashjc <at> uottawa.ca> writes:
> >> I was preparing a fix for a minor glitch in my optimx package and R CMD
> >> check gave an error that the title was not in title case.
> > [snip] to make Gmane happy ...
> >> I have found
> >> A Replacement and Extension of the _optim()_ Function
> >> does not get the complaint, but I'm not sure the underscore is allowed.
> >> Given that I've obeyed the RTFM rule, I'm wondering what to do now.
> > Presumably you should ask the CRAN maintainers? That seems to
> > be the only possible answer -- I don't think anyone else can guess
> > very accurately ...
> From WRE:
> "Refer to other packages and external software in single quotes, and to
> book titles (and similar) in double quotes."
> Other non-English usage (as documented for the Description field; this
> inlcudes function names) can also be used in single quotes.
> Uwe Ligges
Does this then constitute a bug in the package-checking code?
With a just-updated R-devel, for a test case I get:
The Title field should be in title case, current version then in title case:
‘Support Functions and Data for "Ecological Models and Data" plus 'optim()'’
‘Support Functions and Data for "Ecological Models and Data" Plus 'Optim()'’
(while I'm nit-picking, I will say that the first time I got a version
of this error a few weeks ago, it took me two or three tries to parse
what "..., current version then in title case" meant. It is perfectly
correct, I just found it really hard to understand ...)
More information about the R-devel