[rkward-devel] R2HTML orphaned on CRAN
nalimilan at club.fr
Sun Aug 24 13:33:32 UTC 2014
Le dimanche 24 août 2014 à 15:29 +0200, Thomas Friedrichsmeier a écrit :
> On Sunday 24 August 2014 12:35:16 Milan Bouchet-Valat wrote:
> > > I'm uncertain, whether we should
> > > a) use S3-method markup, anyway
> > > b) rename HTML.cormat to HTMLcormat, breaking the API (although of course
> > > we could keep a deprecated HTML.cormat along with a))
> > > c) Ignore the note, assuming that CRAN maintainers will be ok with it.
> > >
> > > I tend to think, b) may be the best option after all.
> > Breaking the API because of a silly WARNING does not seem like the best
> > option to me. Why not a) instead, since it has no effect on the actual
> > code, just on the docs? The doc page makes it obvious anyway that it's
> > not a S3 method.
> well, a) is certainly the easiest option, by all means. The (acceptable)
> downside to this is that the usage-section will then be rendered as
> ## S3 method for class 'cormat'
> while you really have to call HTML.cormat(). The example section is not
> affected, though.
> As the package maintainer, it's your call ;-).
What a responsibility! :-)
Really, I don't care about the ## S3 method comment, as long as the
description is explicit, so go ahead with solution a).
More information about the Rkward-devel