release() and \Sexpr{} in documentation

[krlmlr]

By default, submit_cran() (called from release()) will build the package with --no-manual. However, a pre-built manual seems to be necessary when the package's documentation contains \Sexpr{} constructs.

Example: johnmyleswhite/log4r

[hadley]

I'd be happy to review a pull request.

[krlmlr]

Detection if a pre-built manual is necessary happens here: https://github.com/wch/r-source/blob/2b9bb44c6f9b03bd05b06823592b0c2ad0fa5b30/src/library/tools/R/QC.R#L6683. I'd rather not replicate this check.

I was thinking about adding a new field to DESCRIPTION, like DevtoolsBuildOptions or DevtoolsBuildManual. Of course, simply having extra arguments to release() is much easier to implement.

As releases tend to happen rarely, I think I'll stick with simply adding arguments.

[hadley]

I think adding a built argument is overkill - the only reason that the manual isn't built already is an oversight on my part - it should always be built for release().

[krlmlr]

Is a pre-built manual always required? Are you going to implement this, or would you like me to resubmit?

[hadley]

I think it should be always included although obviously it's not required or CRAN would've complained by now. Would you mind doing a PR? It's not a high priority for me.

[krlmlr]

If you look at the code, the manual actually is built only if necessary, even if --no-manual is omitted. So, this is the way to go.

[lock]

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/