From 9d611dde2757ea7809d06eb043607d8c41da7317 Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Tue, 17 May 2016 19:22:14 -0700 Subject: [PATCH] fix #7 added note to docs about validate method error messages --- DESCRIPTION | 2 +- R/geojson_validate.R | 7 +++++++ man/geojson_validate.Rd | 8 ++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index a971fbf..45d23b2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,7 +5,7 @@ Description: Tools for linting 'GeoJSON'. Includes tools for interacting with th (), and validating against a GeoJSON schema via the Javascript library (). -Version: 0.0.7.29000 +Version: 0.0.7.9500 License: MIT + file LICENSE Authors@R: c( person("Scott", "Chamberlain", role = c("aut", "cre"), email = "myrmecocystus@gmail.com"), diff --git a/R/geojson_validate.R b/R/geojson_validate.R index a5c30ee..f22df3b 100644 --- a/R/geojson_validate.R +++ b/R/geojson_validate.R @@ -12,6 +12,13 @@ #' Default: \code{FALSE} #' #' @importFrom jsonvalidate json_validator +#' +#' @details Sometimes you may get a response that your input GeoJSON is invalid, but +#' get a somewhat unhelpful error message, e.g., \code{no (or more than one) schemas match} +#' See \url{https://github.com/ropenscilabs/geojsonlint/issues/7#issuecomment-219881961}. +#' We'll hopefully soon get this sorted out so you'll get a meaningful error message. +#' However, this method is faster than the other two methods in this package, so +#' there is that. #' #' @return \code{TRUE} or \code{FALSE}. If \code{verbose=TRUE} an attribute #' of name \code{errors} is added with error information diff --git a/man/geojson_validate.Rd b/man/geojson_validate.Rd index e095581..de12e13 100644 --- a/man/geojson_validate.Rd +++ b/man/geojson_validate.Rd @@ -27,6 +27,14 @@ of name \code{errors} is added with error information \description{ Validate GeoJSON using is-my-json-valid Javascript library } +\details{ +Sometimes you may get a response that your input GeoJSON is invalid, but +get a somewhat unhelpful error message, e.g., \code{no (or more than one) schemas match} +See \url{https://github.com/ropenscilabs/geojsonlint/issues/7#issuecomment-219881961}. +We'll hopefully soon get this sorted out so you'll get a meaningful error message. +However, this method is faster than the other two methods in this package, so +there is that. +} \examples{ # From a json character string geojson_validate(x = '{"type": "Point", "coordinates": [-100, 80]}') # good