Fixed mistake in documentation

karthik · karthik · commit 616a2cc32f87 · 2015-02-15T22:31:02.000+01:00
diff --git a/R/gist_map.R b/R/gist_map.R
@@ -4,7 +4,7 @@
 #'
 #'Takes a gist object and a input geojson file name and renders fullscreen map
 #' @param file Must be a geojson file
-#' @param gist_object An object generated by \code{gist_id}
+#' @param gist_object An object of class \code{gist_id} generated by \code{gist_create}
 #' @param  browse Default is \code{TRUE}. Set to \code{FALSE} if you don't want to automatically browse to the URL.
 #' @export
 #' @import assertthat
diff --git a/man/gist_map.Rd b/man/gist_map.Rd
@@ -9,7 +9,7 @@ gist_map(file = NULL, gist_object, browse = TRUE)
 \arguments{
 \item{file}{Must be a geojson file}
 
-\item{gist_object}{An object generated by \code{gist_id}}
+\item{gist_object}{An object of class \code{gist_id} generated by \code{gist_create}}
 
 \item{browse}{Default is \code{TRUE}. Set to \code{FALSE} if you don't want to automatically browse to the URL.}
 }

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ gist_map(file = NULL, gist_object, browse = TRUE)`
`9`	`9`	`\arguments{`
`10`	`10`	`\item{file}{Must be a geojson file}`
`11`	`11`
`12`		`-\item{gist_object}{An object generated by \code{gist_id}}`
	`12`	`+\item{gist_object}{An object of class \code{gist_id} generated by \code{gist_create}}`
`13`	`13`
`14`	`14`	`\item{browse}{Default is \code{TRUE}. Set to \code{FALSE} if you don't want to automatically browse to the URL.}`
`15`	`15`	`}`