[Bioc-devel] [Rd] R-devel:codocClasses() now finds more --> R CMD check warnings

Martin Maechler maechler at stat.math.ethz.ch
Wed Jun 3 11:45:45 CEST 2009

       ["Forwarded" to Bioc-Devel .. as probably quite a few
         bioconductor packages will be "affected".   MM ]

Yesterday, I have commited
	   r48701 | maechler | 2009-06-02 17:11:50
a changed version of  tools::codocClasses()
which checks S4 class slot documentations in many more cases
than previously.
This finds slot documentation inconsistencies in many more cases
than previously, and you (as package author) will probably see
the effect in new warnings in

    R CMD check <mypackage>

if your package defines (and exports, hence documents) S4
classes.  The NEWS entry is

    o	codocClasses() which checks consistency of S4 class slots'
	documentation, now does this in considerably more cases.  The
	documentation of inherited slots (from superclasses) is now
	optional.  This affects 'R CMD check <pkg>' when the package
	defines S4 classes.

I have checked the new behavior in quite a few cases, and the
new code did indeed correctly find slight documentation
inconsistencies in quite a few cases (including our own
recommended package 'Matrix'), so *is* helpful .....
even though you at first may experience the new warnings as
annoying ;-)

Feedback is welcome,
and patches to improve  promptClass() to automatically mark
slots from superclasses as only *optional* to document 
are even more welcome !

Martin Maechler, ETH Zurich

R-devel at r-project.org mailing list

More information about the Bioc-devel mailing list