[R-pkg-devel] Workaround for code/documentation mismatch
What is the behaviour of %while% if not preceded by an expression wrapped in do() ?
On Wed, 11 Aug 2021 at 1:26 pm, Andrew Simmons <akwsimmo at gmail.com> wrote:
Hello,
I've written two functions to emulate do while/until loops seen in other
languages, but I'm having trouble documenting its usage. The function is
typically used like:
do ({
expr1
expr2
...
}) %while% (cond)
so I want to document it something like:
do(expr) %while% (cond)
do(expr) %until% (cond)
to look like the documentation for 'while' and 'if', but R CMD check
produces a "Code/documentation mismatch" warning, complaining that the
documentation should look like:
expr %while% cond
expr %until% cond
So, my question is, is there a way to bypass the
* checking for code/documentation mismatches
portion of R CMD check, at least for one file? Some way to acknowledge that
the code and documentation will mismatch, but that's okay.
Thank you!
[[alternative HTML version deleted]]
______________________________________________ R-package-devel at r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel