summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authormatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-07-01 21:20:44 +0000
committermatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-07-01 21:20:44 +0000
commita5e227edfe3d6dbfe24c2a74e347904151e85c6c (patch)
tree453c6c36ccf08952f5546407366af1b76f5f56d2 /string.c
parent841cf3b9488c0e7ea23b92acbb9078dee3347deb (diff)
* hash.c (rb_hash_hash): documentation fix. a patch from
Marc-Andre Lafortune. [ruby-core:23943] * object.c (rb_mod_cmp): ditto. * range.c (range_eq): ditto. * string.c (rb_str_partition, rb_str_rpartition): ditto. * struct.c (rb_struct_s_def): ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23930 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'string.c')
-rw-r--r--string.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/string.c b/string.c
index c9561208aa..9418bfe2ca 100644
--- a/string.c
+++ b/string.c
@@ -6884,13 +6884,16 @@ rb_str_center(int argc, VALUE *argv, VALUE str)
/*
* call-seq:
* str.partition(sep) => [head, sep, tail]
+ * str.partition(regexp) => [head, match, tail]
*
- * Searches the string for <i>sep</i> and returns the part before
- * it, the <i>sep</i>, and the part after it. If <i>sep</i> is not found,
- * returns <i>str</i> and two empty strings.
+ * Searches <i>sep</i> or pattern (<i>regexp</i>) in the string
+ * and returns the part before it, the match, and the part
+ * after it.
+ * If it is not found, returns two empty strings and <i>str</i>.
*
* "hello".partition("l") #=> ["he", "l", "lo"]
* "hello".partition("x") #=> ["hello", "", ""]
+ * "hello".partition(/.l/) #=> ["h", "el", "lo"]
*/
static VALUE
@@ -6930,15 +6933,17 @@ rb_str_partition(VALUE str, VALUE sep)
/*
* call-seq:
- * str.rpartition(sep) => [head, sep, tail]
+ * str.rpartition(sep) => [head, sep, tail]
+ * str.rpartition(regexp) => [head, match, tail]
*
- * Searches <i>sep</i> in the string from the end of the string, and
- * returns the part before it, the <i>sep</i>, and the part after it.
- * If <i>sep</i> is not found, returns two empty strings and
- * <i>str</i>.
+ * Searches <i>sep</i> or pattern (<i>regexp</i>) in the string from the end
+ * of the string, and returns the part before it, the match, and the part
+ * after it.
+ * If it is not found, returns two empty strings and <i>str</i>.
*
* "hello".rpartition("l") #=> ["hel", "l", "o"]
* "hello".rpartition("x") #=> ["", "", "hello"]
+ * "hello".rpartition(/.l/) #=> ["he", "ll", "o"]
*/
static VALUE