summaryrefslogtreecommitdiff
path: root/sv.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2018-08-04 13:13:32 -0600
committerKarl Williamson <khw@cpan.org>2018-08-05 05:52:48 -0600
commitf8b5b1ae0ffffe9f2ed056ed98119524101cb8fb (patch)
tree0152fe6c2d55dd106dc9a4185776e0035443a2f9 /sv.c
parent177157118a96faed584a3fe8fab9dc708a132c6a (diff)
downloadperl-f8b5b1ae0ffffe9f2ed056ed98119524101cb8fb.tar.gz
perlapi: Clarify sv_insert()
Diffstat (limited to 'sv.c')
-rw-r--r--sv.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/sv.c b/sv.c
index 92ce540a3c..ed7047e923 100644
--- a/sv.c
+++ b/sv.c
@@ -6272,8 +6272,10 @@ Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
/*
=for apidoc sv_insert
-Inserts a string at the specified offset/length within the SV. Similar to
-the Perl C<substr()> function. Handles get magic.
+Inserts and/or replaces a string at the specified offset/length within the SV.
+Similar to the Perl C<substr()> function, with C<littlelen> bytes starting at
+C<little> replacing C<len> bytes of the string in C<bigstr> starting at
+C<offset>. Handles get magic.
=for apidoc sv_insert_flags