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

infix operator containing "<-" results in incorrect usage section #554

Closed
nteetor opened this issue Jan 4, 2017 · 0 comments
Closed

infix operator containing "<-" results in incorrect usage section #554

nteetor opened this issue Jan 4, 2017 · 0 comments

Comments

@nteetor
Copy link
Member

@nteetor nteetor commented Jan 4, 2017

The roxygen documentation below,

#' Custom Assignment
#'
#' My assignment operator.
#'
#' @param x A name.
#' @param value A value to assign.
#'
#' @export
`%<-%` <- function(x, value) {
  value
}

, produces the following .rd file,

\name{\%<-\%}
\alias{\%<-\%}
\title{Custom Assignment}
\usage{
\%\%(x) <- value
}
\arguments{
\item{x}{A name.}

\item{value}{A value to assign.}
}
\description{
My assignment operator.
}

The usage section should read,

\usage{
x %<-% value
}
@hadley hadley closed this in 6c26d86 Jan 30, 2017
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 pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant