Re: [Rd] promptClass("numeric")

From: Deepayan Sarkar <deepayan_at_stat.wisc.edu>
Date: Tue 17 Aug 2004 - 01:33:38 EST

On Monday 16 August 2004 09:43, Wolski wrote:
> Hi!
>
> As I said its not really a Problem. Its just an inconsistency which
> need is not apparent to me.
>
> You can alternatively use promptClass or promptMethods to document
> methods.
>
> promptClass always generates a section:
> >>>>\section{Methods}{
> >>>> \describe{
> >>>> \item{coerce}{\code{signature(from = "ANY", to =
> >>>> "numeric")}: ... } }
> >>>> }
>
> So you can use promptClass to provide a short description to your
> methods.
>
> I would use promptMethods if the methods are elaborated (like a the
> plotting methods in package lattice) and I would like to to provide
> intensive and extensive explanation with examples.
>
> But in case if my method "foo" which is so simple (it just prints
> "foo") I would like to use promptClass.

Yes, I should have RTFM before replying. On closer inspection, this seems to be a feature (?) of the "numeric" class (and perhaps other primitive classes). It works as you expect for a freshly defined formal class.

Deepayan



R-devel@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Tue Aug 17 01:36:29 2004

This archive was generated by hypermail 2.1.8 : Wed 03 Nov 2004 - 22:45:07 EST