Added some stuff for Return

Dasonk · Oct 4, 2012 · f01328d · f01328d
1 parent 87ee006
commit f01328d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/R/Return.R b/R/Return.R
@@ -1,9 +1,11 @@
 #' Look at flydoc return
 #' 
 #' Look at the the return for your flydoc documnetation
-#' for a given function
+#' for a given function.  This is what drives the section
+#' labeled "Value" in the help files.
 #' 
 #' @param fun A function
+#' @aliases Value
 #' @export
 Return <- function(fun){
     fdGet("Return", fun)
@@ -12,7 +14,8 @@ Return <- function(fun){
 #' Set documentation for return
 #' 
 #' Set a return for your flydoc documentation for a
-#' given function
+#' given function. This is what drive the section
+#' labeled "Value" in the help files.
 #' 
 #' @param func A function to add a flydoc return to.
 #' @param value A character string containing the 

diff --git a/man/Return-set.Rd b/man/Return-set.Rd
@@ -12,6 +12,7 @@
 }
 \description{
   Set a return for your flydoc documentation for a given
-  function
+  function. This is what drive the section labeled "Value"
+  in the help files.
 }
 
diff --git a/man/Return.Rd b/man/Return.Rd
@@ -1,5 +1,6 @@
 \name{Return}
 \alias{Return}
+\alias{Value}
 \title{Look at flydoc return}
 \usage{
   Return(fun)
@@ -9,6 +10,7 @@
 }
 \description{
   Look at the the return for your flydoc documnetation for
-  a given function
+  a given function.  This is what drives the section
+  labeled "Value" in the help files.
 }