[Bioc-devel] S4 Methods Documentation Convention Triggers Warnings

Deepayan Sarkar deep@y@n@@@rk@r @end|ng |rom gm@||@com
Sun Jan 29 04:42:39 CET 2023


On Fri, Jan 27, 2023 at 9:26 PM Hervé Pagès <hpages.on.github using gmail.com> wrote:
>
> On 27/01/2023 02:00, Dario Strbenac via Bioc-devel wrote:
>
> > Good day,
> >
> > So, is the ultimate solution to manually change everything to the format of
> >
> > \item{\code{show(x)}:}{
> >    ...
> > } ?
>
> I think I will do this in my own packages. Still need to make those
> changes though, just didn't have time to work on a script to automate this.
>
> >
> > The warnings persist, so it does not seem as though R will revert to allowing the currently-popular syntax past its check.
>
> I don't see that anybody complained about this on R-devel, so they don't
> really have a reason to revert.

I'm open to suppressing the warning for \describe items (the warning
is more important for \arguments). Let me know.

Best,
-Deepayan

> H.
>
> >
> > --------------------------------------
> > Dario Strbenac
> > University of Sydney
> > Camperdown NSW 2050
> > Australia
> > _______________________________________________
> > Bioc-devel using r-project.org mailing list
> > https://stat.ethz.ch/mailman/listinfo/bioc-devel
>
> --
> Hervé Pagès
>
> Bioconductor Core Team
> hpages.on.github using gmail.com
>
> _______________________________________________
> Bioc-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel



More information about the Bioc-devel mailing list