Skip to content
Back to formatted view

Raw Message

Message-ID: <e7d352ad-4fa4-12f0-df1a-51a478920f0d@gmail.com>
Date: 2019-07-24T10:12:35Z
From: Duncan Murdoch
Subject: [R-pkg-devel] Note on winbuilder-develop
In-Reply-To: <23864.1022.975481.596420@stat.math.ethz.ch>

On 24/07/2019 3:08 a.m., Martin Maechler wrote:
>>>>>> Roy Mendelssohn
>>>>>>      on Tue, 23 Jul 2019 18:44:24 -0700 writes:
> 
>      > Thanks, I was looking at the raw files, not the .Rd files.
>      > There are \keyword arguments in those file, will have to
>      > search to see why they are getting generated.  -Roy
> 
> just to rub the obvious into everybody's face ;-) :-D
> { apology for any offence ! } :
> 
> If you'd use roxygen only initially and not anymore from then
> on, but rather then would keep hand-editing nicely humanly
> formatted  man/*.Rd  files,
> you would never see this (and quite a few "similar") problems.

I don't think that's a great idea, unless the initial use is basically 
no more than using prompt().  If you have comments in your source that 
look like help text, and different help text in your Rd file, it's going 
to lead to confusion.  I don't think Roxygen is capable of updating your 
source file comments when you edit your Rd file.

Duncan Murdoch