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

Error when usage documentation uses qualified names #795

Closed
klmr opened this Issue Sep 7, 2018 · 2 comments

Comments

Projects
None yet
3 participants
@klmr
Copy link

klmr commented Sep 7, 2018

I’ve got a package that isn’t supposed to be attached. The documentation of functions makes this explicit by showing the @usage with a namespace qualifier:

#' …
#' @usage
#' pkg::func(args)

This causes pkgdown::build_site() to issue the following error:

Error in fun_info(x) : Unknown call: ::

Indeed, pkgdown:::fun_info (or rather, functions further upstream, parse_usage and usage_type) fail to handle qualified function calls. I’d love to contribute a PR but I’m unsure where and how best to handle this case.

@jayhesselberth

This comment has been minimized.

Copy link
Collaborator

jayhesselberth commented Oct 7, 2018

Could you please build a minimal package that recreates the issue?

@klmr

This comment has been minimized.

Copy link
Author

klmr commented Oct 7, 2018

Here’s a zip of the package: test-0.0.0.9000.tar.gz

jayhesselberth added a commit that referenced this issue Oct 21, 2018

@jayhesselberth jayhesselberth added this to the 1.2.0 milestone Oct 24, 2018

@hadley hadley added bug rd-translation 🎏 and removed reprex labels Nov 6, 2018

@hadley hadley closed this in #848 Nov 6, 2018

hadley added a commit that referenced this issue Nov 6, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment