[Rd] Title case in DESCRIPTION for package where a word is a function name

Uwe Ligges ligges at statistik.tu-dortmund.de
Sat Apr 25 00:17:09 CEST 2015

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

>    Ben Bolker
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel

More information about the R-devel mailing list