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

Typing ?function in console goes to manpage for function-package not function after use_roxygen_md #1886

Closed
SimonDedman opened this issue Aug 15, 2023 · 2 comments

Comments

@SimonDedman
Copy link
Contributor

SimonDedman commented Aug 15, 2023

I installed lifecycle which asked me to first do usethis::use_roxygen_md and I think (not 100% sure) that this is the reason that when I now type
?function
For a function within my package, the help pane displays the manpage for the package, not for the function of the same name.

remotes::install_github("SimonDedman/gbm.auto")
library(gbm.auto)
?gbm.auto

Does it seem reasonably logical that installing use_roxygen_md and/or lifecycle would cause this? These (and possibly related required installs) led to all manpages being converted to .Rd, and gbm.auto-package being created.

Is there anything I can do about this? It's so nice to be able to jump straight to a function's manpage using ?function, instead of clicking to the package, then the function within it. Thanks in advance!

@hadley
Copy link
Member

hadley commented Nov 3, 2023

I think use_package_doc() is more likely to be the culprit here. If you open {yourpackage}-package.R you should be able to fix the roxygen there.

@hadley hadley closed this as completed Nov 3, 2023
@SimonDedman
Copy link
Contributor Author

Thanks Hadley. Yep, I was able to solve this with Jenny's approach here. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants