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

Issue with %in% in roxygen comment #742

Closed
ebridge2 opened this issue May 24, 2018 · 1 comment
Closed

Issue with %in% in roxygen comment #742

ebridge2 opened this issue May 24, 2018 · 1 comment

Comments

@ebridge2
Copy link

Hi,

I have the following roxygen comment:

#' @param community.attribute the attribute of the graph vertices denoting the vertex communities. Should be that \code{community.attribute %in% names(vertex.attributes(g))}.

that throws the roxygen warning:

Warning: @param <file#linenumber>: mismatched braces or quotes

when I delete the %in% the warning goes away. Is this desired behavior?

@hadley
Copy link
Member

hadley commented Jun 28, 2018

You need to escape % because it's the Rd commenting character. Alternatively, if you use markdown formatting (and the development version), roxygen2 will escape for you:

#' @param community.attribute the attribute of the graph
#'   vertices denoting the vertex communities. Should be that 
#'   `community.attribute %in% names(vertex.attributes(g))`.

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