[Rd] question about assignment warnings for replacement methods

From: Marc Carlson <mcarlson_at_fhcrc.org>
Date: Tue, 05 Apr 2011 10:51:39 -0700


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



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Tue 05 Apr 2011 - 17:55:05 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Tue 05 Apr 2011 - 19:00:40 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.

list of date sections of archive