[R-pkg-devel] lost braces note on CRAN pretest related to \itemize

Georgi Boshnakov georg|@bo@hn@kov @end|ng |rom m@nche@ter@@c@uk
Tue Jan 23 21:14:13 CET 2024


The notes you get illustrate why they are useful, if you look at your rendered documentation you probably will see something wrong. Thousands of packages on CRAN, including some of mines have had this kind of infelicities for years.

Firstly, the two sets of braces suggest that you meant a description environment, not itemize (in which  its only argument doesn't need braces).

Secondly, in the value section, \item is implicitly enclosed in \describe and you don't need to include the latter.

Georgi Boshnakov


Sent from Outlook for Android<https://aka.ms/AAb9ysg>

________________________________
From: R-package-devel <r-package-devel-bounces using r-project.org> on behalf of Patrick Giraudoux <patrick.giraudoux using univ-fcomte.fr>
Sent: Tuesday, January 23, 2024 7:09:22 pm
To: Dirk Eddelbuettel <edd using debian.org>
Cc: R Package Development <r-package-devel using r-project.org>
Subject: Re: [R-pkg-devel]  lost braces note on CRAN pretest related to \itemize

OK. Clear enough. CRAN applies a new "filter" as it was going through
without crying a note since decades ;-). However, indeed, re-checking
the manual "Writing R extensions" my syntax was wrong...
Thanks for the guidance,
Patrick

Le 23/01/2024 � 19:58, Dirk Eddelbuettel a �crit :
> On 23 January 2024 at 19:39, Patrick Giraudoux wrote:
> | Has anyone an idea about what is going wrong ?
>
> \item has no braces following it.  From a package I submitted today and for
> which I still have NEWS.Rd in the editor (indented here):
>
>    \section{Changes in version 0.0.22 (2024-01-23)}{
>      \itemize{
>        \item Replace empty examples macros to satisfy CRAN request.
>      }
>    }
>
> Hth,  Dirk
>

        [[alternative HTML version deleted]]

______________________________________________
R-package-devel using r-project.org mailing list
https://urldefense.com/v3/__https://stat.ethz.ch/mailman/listinfo/r-package-devel__;!!PDiH4ENfjr2_Jw!Gu9AhS4Yi4k5IC8TXv4B8xpznl-8-Jhl-cdxRZ6zVrRCdmDaSTVYpaG5XDoitdms9FuHQGV7adP-Q6WD6w2bMws_b5UnszsH5VsXFBMUIvFX4Nc$ [stat[.]ethz[.]ch]


	[[alternative HTML version deleted]]



More information about the R-package-devel mailing list