From murdoch.duncan at gmail.com  Thu Mar 17 10:15:16 2011
From: murdoch.duncan at gmail.com (Duncan Murdoch)
Date: Thu, 17 Mar 2011 05:15:16 -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: <4D81D124.4070907@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 also tried to narrow it down with tools:checkRd() but as I mentioned
> earlier, this function does not produce the same output as R CMD check and
> the same thing happens in the case of the warning above. I ran checkRd() on
> all 34 .Rd files and did not see the warning above.
>
> I'd worry that people might give up and not try and find the source of
> warnings if it proves too difficult.
> Thanks for considering this idea...

That sounds like a good idea.  It would be easier to experiment with if 
you provided the offending file.  (Yes, the lack of a name makes it hard 
to find that file, but it's easier for you than for almost anyone else.)

Duncan Murdoch



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