Doc: Improve documentation on JSON#parse and JSON#parse!

hsbt · brunojabs · hsbt · commit 75ada77b9664 · 2021-12-02T16:42:41.000+09:00
Co-authored-by: Bruno Gomes da Silva &lt;brunojabs@gmail.com&gt;
diff --git 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
@@ -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)
 {

Original file line number	Diff line number	Diff line change
`@@ -2950,6 +2950,7 @@ static const char MAYBE_UNUSED(_JSON_nfa_pop_trans)[] = {`
`2950`	`2950`	`*`
`2951`	`2951`	`* Parses the current JSON text _source_ and returns the complete data`
`2952`	`2952`	`* structure as a result.`
	`2953`	`+* It raises JSON::ParseError if fail to parse.`
`2953`	`2954`	`*/`
`2954`	`2955`	`static VALUE cParser_parse(VALUE self)`
`2955`	`2956`	`{`
Original file line number	Diff line number	Diff line change
`@@ -839,6 +839,7 @@ static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)`
`839`	`839`	`*`
`840`	`840`	`* Parses the current JSON text _source_ and returns the complete data`
`841`	`841`	`* structure as a result.`
	`842`	`+ * It raises JSON::ParseError if fail to parse.`
`842`	`843`	`*/`
`843`	`844`	`static VALUE cParser_parse(VALUE self)`
`844`	`845`	`{`