From murdoch.duncan at gmail.com  Thu Mar 17 10:36:54 2011
From: murdoch.duncan at gmail.com (Duncan Murdoch)
Date: Thu, 17 Mar 2011 05:36:54 -0400
Subject: [Rd] Feature request: display file name in R CMD check warning
In-Reply-To: <AANLkTi=D483mk=SVgM5w4bd9gazMA2XeFS_ufLNHOTyL@mail.gmail.com>
References: <AANLkTi=D483mk=SVgM5w4bd9gazMA2XeFS_ufLNHOTyL@mail.gmail.com>
Message-ID: <4D81D636.2060209@gmail.com>

On 16/03/2011 7:55 PM, Dan Tenenbaum wrote:
> Hi,
>
> I came across the following warning in R CMD check (it only occurred on
> Windows):
>
> The \usage entries for S3 methods should use the \method markup and not
>> their full name.
>> See the chapter 'Writing R documentation files' in manual 'Writing R
>> Extensions'.
>
>
> The package I'm looking at is one that I did not write which has 34 .Rd
> files. This warning does not tell me which file to look in. It would be very
> helpful if it did. Same goes for other warnings/errors produced by R CMD
> check.

I was unable to duplicate this.  When I tried it by messing up one of 
the man pages in the ellipse package, I got this:

S3 methods shown with full name in documentation object 'ellipse.glm':
   ellipse.glm

The \usage entries for S3 methods should use the \method markup and not
their full name.
See the chapter 'Writing R documentation files' in manual 'Writing R
Extensions'.

"Documentation object 'ellipse.glm'" tells me the \name{} inside the .Rd 
file, which is enough to uniquely identify the file.  Are you not seeing 
this part of the message?

Duncan Murdoch



[Rd] Feature request: display file name in R CMD check warning
Duncan Murdoch