Merge pull request #5161 from dearblue/ary-splice

Fix documents for `mrb_ary_splice()` [ci skip]
mruby · Nov 21, 2020 · 55e1275 · 55e1275
2 parents c6c18c3 + 3ac6c3f
commit 55e1275
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/include/mruby/array.h b/include/mruby/array.h
@@ -249,10 +249,10 @@ MRB_API mrb_value mrb_ary_entry(mrb_value ary, mrb_int offset);
  *
  * Equivalent to:
  *
- *      ary.shift
+ *      ary[head, len] = rpl
  *
  * @param mrb The mruby state reference.
- * @param self The array from which the value will be shifted.
+ * @param self The array from which the value will be partiality replaced.
  * @param head Beginning position of a replacement subsequence.
  * @param len Length of a replacement subsequence.
  * @param rpl The array of replacement elements.