Georgi Boshnakov
2019-Apr-17 06:42 UTC
[Rd] R CMD check does not report redundant '...' argument described in Rd File
R's checks seem to be failing to notice a redundant '...' argument described in the documentation of a function. Consider a function: fun_3 <- function(arg1, arg2, arg3) { "I am fun_3" } If its documentation describes an argument, say 'dummy', R check reports something like: * checking Rd \usage sections ... WARNING Documented arguments not in \usage in documentation object 'fun_3b': 'dummy' ... But if the non-existent argument is '...' or '\dots' there is no warning. The omission seems specific to the 'dots' argument. Checked under Windows on win-builder on 17 April 2018 with R version 3.6.0 beta (2019-04-16 r76403), R version 3.5.3 (2019-03-11) and R version 3.4.4 (2018-03-15). A minimal package illustrating this is at https://github.com/GeoBosh/reprexes/tree/master/redundantDots Georgi Boshnakov
Pages, Herve
2019-Apr-22 06:16 UTC
[Rd] R CMD check does not report redundant '...' argument described in Rd File
Hi, FWIW I also noticed this problem and reported it on R?s Bugzilla 4 years ago: https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16223 I actually had to report it twice because my first report (https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16153) was closed after a few days and tagged as NOT REPRODUCIBLE. Cheers, H. On 4/16/19 23:42, Georgi Boshnakov wrote:> R's checks seem to be failing to notice a redundant '...' argument described in the documentation of a function. > > Consider a function: > > fun_3 <- function(arg1, arg2, arg3) { > "I am fun_3" > } > > If its documentation describes an argument, say 'dummy', R check reports something like: > > * checking Rd \usage sections ... WARNING > Documented arguments not in \usage in documentation object 'fun_3b': > 'dummy' > ... > > But if the non-existent argument is '...' or '\dots' there is no warning. The omission seems specific to the 'dots' argument. > > Checked under Windows on win-builder on 17 April 2018 with > R version 3.6.0 beta (2019-04-16 r76403), R version 3.5.3 (2019-03-11) and > R version 3.4.4 (2018-03-15). > > A minimal package illustrating this is at > https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_GeoBosh_reprexes_tree_master_redundantDots&d=DwIFAg&c=eRAMFD45gAfqt84VtBcfhQ&r=BK7q3XeAvimeWdGbWY_wJYbW0WYiZvSXAJJKaaPhzWA&m=i9g7pqJ1WilGjLfFwtSiajoznNNRWj8CWL0sdNSLKFM&s=8pmMlfLXNctV2CZNAADigKW4C_ZU5phJ5J3EhY7gq7U&e> > > Georgi Boshnakov > > ______________________________________________ > R-devel at r-project.org mailing list > https://urldefense.proofpoint.com/v2/url?u=https-3A__stat.ethz.ch_mailman_listinfo_r-2Ddevel&d=DwIFAg&c=eRAMFD45gAfqt84VtBcfhQ&r=BK7q3XeAvimeWdGbWY_wJYbW0WYiZvSXAJJKaaPhzWA&m=i9g7pqJ1WilGjLfFwtSiajoznNNRWj8CWL0sdNSLKFM&s=VepWHiukhgfnvGnmA3S-5XhITPslNPVKxWwlBeazkEY&e-- Herv? Pag?s Program in Computational Biology Division of Public Health Sciences Fred Hutchinson Cancer Research Center 1100 Fairview Ave. N, M1-B514 P.O. Box 19024 Seattle, WA 98109-1024 E-mail: hpages at fredhutch.org Phone: (206) 667-5791 Fax: (206) 667-1319