From murdoch at stats.uwo.ca  Fri Feb 24 20:11:13 2006
From: murdoch at stats.uwo.ca (Duncan Murdoch)
Date: Fri, 24 Feb 2006 14:11:13 -0500
Subject: [Rd] Links to non-vignette documentation
In-Reply-To: <f8e6ff050602240842i6781e882mcfad6a7961e64dcb@mail.gmail.com>
References: <f8e6ff050602230853l7eb9cfe6n7458e718ce7934b3@mail.gmail.com>	
	<Pine.LNX.4.64.0602232044190.25797@gannet.stats.ox.ac.uk>	
	<f8e6ff050602231323m7a0779bdrb694f85758df6f3d@mail.gmail.com>	
	<43FE3453.6020405@stats.uwo.ca>	
	<f8e6ff050602231449l187478f1mcb166915b02c4f3e@mail.gmail.com>	
	<43FE66A5.3090103@stats.uwo.ca>	
	<f8e6ff050602231902i6b999b8m952a58ff459e6914@mail.gmail.com>	
	<43FEF2E3.3070609@stats.uwo.ca>	
	<f8e6ff050602240629j2f31d4e7g23dd726472010114@mail.gmail.com>	
	<43FF3672.70801@stats.uwo.ca>
	<f8e6ff050602240842i6781e882mcfad6a7961e64dcb@mail.gmail.com>
Message-ID: <43FF5A51.7030700@stats.uwo.ca>

On 2/24/2006 11:42 AM, hadley wickham wrote:
>> > When was this form of package documentation created?  How are users
>> > supposed to know it exists?  I couldn't find any pointers to it from
>> > ?help, ?library or from help(package=XXX).
>>
>> It's described in the Writing R Extensions Manual, in Writing R
>> Documentation Files, Rd Format, Documenting Packages (section 2.1.4 in
>> the PDF).
> 
> That's great for developers, but how are users supposed to find out?

I think users would be disappointed if they tried using package?foo 
right now, because mostly it tells you there's no such man page.  First 
you need a few more developers to follow the recommendations, before it 
really makes sense to advertise the feature.

An alternative approach would be for R CMD check to warn developers who 
don't have such a man page.  That would encourage adoption of this 
convention, but there were quite a few objections when I suggested it. 
It does put a load on package authors.

Another alternative would be for a default package man page to be built 
if the developer didn't supply one; that's probably a good idea, but not 
one I have time to act on before 2.3.x, so it's not coming soon.

If you feel like writing some patches to the documentation in the 
appropriate places, and it looks as though they won't mislead readers, 
please do so, and I'll review and commit them.  If you want to revise 
the package build scripts, you're going to need to find someone else to 
commit them; I will not have enough time to review things that could 
cause that much trouble if you get it wrong.

Duncan Murdoch



[Rd] Links to non-vignette documentation
Duncan Murdoch