Giter Site home page Giter Site logo

Comments (4)

moodymudskipper avatar moodymudskipper commented on June 18, 2024 1

solved by explicit @usage definitions, escaping the \%.

f494084

50502be

CMD check now succeeds

from inops.

karoliskoncevicius avatar karoliskoncevicius commented on June 18, 2024

This might be bug in Roxygen actually, but not sure. I remember that for infixer I had to adjust the usage in the docs manually for them to pass CMD check.

from inops.

moodymudskipper avatar moodymudskipper commented on June 18, 2024

It seems like we can define the usage manually as described in this answer : https://stackoverflow.com/questions/13322021/assignment-function-documentation-fails-r-cmd-check

Examples given :

 #' Assign sp feature IDs
#' @rdname IDs
#' @usage IDs(x) <- value
"IDs<-" <- function( x, value ) {
    UseMethod("IDs<-",x)
}

#' @method IDs<- SpatialPolygonsDataFrame
#' @S3method IDs<- SpatialPolygonsDataFrame
#' @rdname IDs
#' @usage IDs(x) <- value
"IDs<-.SpatialPolygonsDataFrame" <- function( x, value) {
    spChFIDs(x,value)
}

Untested yet

Maybe that's what you meant, but I didn't know @Usage and thought first you had edited the doc files manually.

from inops.

karoliskoncevicius avatar karoliskoncevicius commented on June 18, 2024

Nice!

from inops.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.