From mcarlson at fhcrc.org  Tue Apr  5 19:51:39 2011
From: mcarlson at fhcrc.org (Marc Carlson)
Date: Tue, 05 Apr 2011 10:51:39 -0700
Subject: [Rd] question about assignment warnings for replacement methods
Message-ID: <4D9B56AB.2020403@fhcrc.org>

Hi,

I have seen several packages that with the most recent version of R are 
giving a warning like this:

Assignments in \usage in documentation object 'marginalData-methods':
marginalData(object) = value

I assume that this is to prevent people from making assignments in their 
usage statements (which seems completely understandable).  But what 
about the case above?  This is a person who just wants to show the 
proper usage for a replacement method.  IOW they just want to write 
something that looks like what you actually do when you use a 
replacement method.  They just want to show users how to do something 
like this:

replacementMethod(object) <- newValue


So is that really something that should not be allowed in a usage 
statement?


   Marc



[Rd] question about assignment warnings for replacement methods
Marc Carlson