r - What is the proper way to document S4 methods in which the signature contains the `<-` class? -


in formula.tools package, define , document rhs method expressions <- b.

#' @rdname formula.parts #' @aliases rhs,set-method setmethod( 'rhs', '<-', function(x) x[[3]] ) 

(n.b. signature list '<-' not wrong, here. class of assignment statement.)

for s4 method, roxyger2-3.1.0, generates following in man/formula.parts.rd:

\s4method{rhs}{<-}(x) 

i believe proper documentation tag should be:

\s4method{rhs}{`<-`}(x)  

is there way force roxygen2 generate correct rd syntax? struggled bit, not find way.

background

  • r-3.0.1
  • roxygen-3.1.0

i answering own questions, after reporting this issue roxygen developers. confirmed not working prior roxygen2-4.0.0. pushed out patch within day. (awesome!) roxygen2 produces correct rd syntax signatures <-.

additional notes: upgrading roxygen2-4.0.0 requires r >= 3.0.2 , newest version of rcpp.


Comments

Popular posts from this blog

Android layout hidden on keyboard show -

google app engine - 403 Forbidden POST - Flask WTForms -

c - Why would PK11_GenerateRandom() return an error -8023? -