adding documentation for %=% operator

1 files changed, 7 insertions, 0 deletions

diff --git a/R/util.R b/R/util.R
index 42d06df..c2c67f8 100644
--- a/R/util.R
+++ b/R/util.R
@@ -1,4 +1,11 @@
 # Generic form
+#' Multiple assignment operator
+#' 
+#' Assign multiple variables from a list or function return object
+#' 
+#' @param lhs,rhs the variables to be assingned, and the list or 
+#' function return object
+#' 
 #' @export
 '%=%' = function(l, r, ...) UseMethod('%=%')