summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiroshi SHIBATA <hsbt@ruby-lang.org>2021-12-02 16:42:41 +0900
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2021-12-02 16:42:41 +0900
commit75ada77b9664c1d1f0ae6e210f8db4919849561e (patch)
treec05e79f10383e240a2ef220f93e9542a29563026
parent32b0185b441dfce26e83964d229ae5b73394e993 (diff)
downloadjson-75ada77b9664c1d1f0ae6e210f8db4919849561e.tar.gz
Doc: Improve documentation on JSON#parse and JSON#parse!
Co-authored-by: Bruno Gomes da Silva <brunojabs@gmail.com>
-rw-r--r--ext/json/ext/parser/parser.c1
-rw-r--r--ext/json/ext/parser/parser.rl1
2 files changed, 2 insertions, 0 deletions
diff --git a/ext/json/ext/parser/parser.c b/ext/json/ext/parser/parser.c
index b1dc881..b7de60d 100644
--- a/ext/json/ext/parser/parser.c
+++ b/ext/json/ext/parser/parser.c
@@ -2950,6 +2950,7 @@ static const char MAYBE_UNUSED(_JSON_nfa_pop_trans)[] = {
*
* Parses the current JSON text _source_ and returns the complete data
* structure as a result.
+* It raises JSON::ParseError if fail to parse.
*/
static VALUE cParser_parse(VALUE self)
{
diff --git a/ext/json/ext/parser/parser.rl b/ext/json/ext/parser/parser.rl
index f7be1a5..15e6b92 100644
--- a/ext/json/ext/parser/parser.rl
+++ b/ext/json/ext/parser/parser.rl
@@ -839,6 +839,7 @@ static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)
*
* Parses the current JSON text _source_ and returns the complete data
* structure as a result.
+ * It raises JSON::ParseError if fail to parse.
*/
static VALUE cParser_parse(VALUE self)
{