Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release() and \Sexpr{} in documentation #603

Closed
krlmlr opened this issue Sep 29, 2014 · 7 comments
Closed

release() and \Sexpr{} in documentation #603

krlmlr opened this issue Sep 29, 2014 · 7 comments

Comments

@krlmlr
Copy link
Member

@krlmlr krlmlr commented Sep 29, 2014

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
Copy link
Member

@hadley hadley commented Sep 29, 2014

I'd be happy to review a pull request.

@krlmlr
Copy link
Member Author

@krlmlr krlmlr commented Oct 6, 2014

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
Copy link
Member

@hadley hadley commented Nov 5, 2014

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
Copy link
Member Author

@krlmlr krlmlr commented Nov 5, 2014

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

@hadley
Copy link
Member

@hadley hadley commented Nov 5, 2014

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
Copy link
Member Author

@krlmlr krlmlr commented Nov 5, 2014

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.

@hadley hadley closed this in #636 Jan 12, 2015
@lock
Copy link

@lock lock bot commented Sep 18, 2018

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/

@lock lock bot locked and limited conversation to collaborators Sep 18, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
2 participants