perlapi: Clarify sv_insert()
authorKarl Williamson <khw@cpan.org>
Sat, 4 Aug 2018 19:13:32 +0000 (13:13 -0600)
committerKarl Williamson <khw@cpan.org>
Sun, 5 Aug 2018 11:52:48 +0000 (05:52 -0600)
sv.c

diff --git a/sv.c b/sv.c
index 92ce540..ed7047e 100644 (file)
--- 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