R/Description.R

In Dasonk/flydoc: Provide documentation for your functions on the fly.

#' Look at flydoc description
#' 
#' Look at the the description for your flydoc documentation
#' for a given function
#' 
#' @param fun A function
#' @export
Description <- function(fun){
    flyget("Description", fun)
}

#' Set a description
#' 
#' Set a description for your flydoc documentation for a
#' given function
#' 
#' @param func A function to add a flydoc description to.
#' @param value A character string containing 
#'  the description to add to the function's documentation
#' @export
"Description<-" <- function(func, value){
    invisible(flyassign("Description", func, value))
}