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

Link to topic file and not alias (pipe) #731

Merged
merged 1 commit into from Jul 3, 2019
Merged

Conversation

@jmgirard
Copy link
Contributor

@jmgirard jmgirard commented Apr 25, 2019

This change will prevent Rd warnings during "Install and Restart" on Windows. However, it may make the link more fragile.
r-lib/roxygen2#707
https://stackoverflow.com/questions/48430093/how-do-i-resolve-rd-warning-missing-file-link-when-building-packages-in-rstudi/48478698#48478698

@jennybc
Copy link
Member

@jennybc jennybc commented Apr 29, 2019

I recently saw something similar, while working on a different package, in my Windows VM. So, yeah, I am inclined to fix this. I'm working on something else now, not on Windows, but just so we get it all recorded: in what exact contexts do we see this? As in: OS (Windows, I know) + ?RStudio? + exactly which step(s) in the R CMD this/that? If you spend a lot of time in Windows, it would be awesome to capture this info in this thread. I don't see it anywhere in travis or appveyor logs, for example.

@jmgirard
Copy link
Contributor Author

@jmgirard jmgirard commented Apr 29, 2019

Happy to help. I'm on Windows 10 using R 3.5.3 and RStudio 1.1.463.

usethis::create_tidy_package("MWE")
usethis::use_tidy_eval()
devtools::document()

Then I click the "Install and Restart" option in the RStudio "Build" tab:

==> Rcmd.exe INSTALL --no-multiarch --with-keep.source MWE


* installing to library 'C:/Users/jgirard/Documents/R/win-library/3.5'
* installing *source* package 'MWE' ...
** R
** byte-compile and prepare package for lazy loading
** help
  converting help for package 'MWE'
*** installing help indices
    finding HTML links ...    tidyeval                                html   done


Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:24: file link 'syms' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:26: file link 'expr' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:26: file link 'quo' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:29: file link 'exprs' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:30: file link 'quos' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:32: file link 'enexpr' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:32: file link 'enquo' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:36: file link 'enexprs' in package 'rlang' does not exist and so has been treated as a topic
Rd warning: C:/Users/jgirard/Documents/MWE/man/tidyeval.Rd:36: file link 'enquos' in package 'rlang' does not exist and so has been treated as a topic
** building package indices
** testing if installed package can be loaded
* DONE (MWE)
In R CMD INSTALL

@jennybc
Copy link
Member

@jennybc jennybc commented Apr 30, 2019

Thanks! These details are exactly what I wanted to capture. I'm not working on usethis at this moment, but I'll be back.

@jennybc jennybc changed the title Link to topic file and not alias Link to topic file and not alias (pipe) Jul 3, 2019
@jennybc
Copy link
Member

@jennybc jennybc commented Jul 3, 2019

Thanks!

@jennybc jennybc merged commit 0b3003e into r-lib:master Jul 3, 2019
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants