diff options
| author | David Mitchell <davem@iabyn.com> | 2017-01-24 13:55:45 +0000 |
|---|---|---|
| committer | David Mitchell <davem@iabyn.com> | 2017-01-24 13:55:45 +0000 |
| commit | 8f5d5a51d02eb509ca7ebc82d950207828c3aa7c (patch) | |
| tree | dad122a8e6d884be167d1e3172d52faa9a1e2825 /pp_sort.c | |
| parent | 1acab4c5e64e8d27d6452f7758b159adf276d017 (diff) | |
| download | perl-8f5d5a51d02eb509ca7ebc82d950207828c3aa7c.tar.gz | |
perlapi.pod: remove AvARRAY() example from sortsv()
The docs for the Perl_sort() API function include a 1-line example
of sorting an AV in-place using AvARRAY(av). Since AvARRAY() isn't
part of the API and the example would fail on tied or magic arrays,
just delete it.
At the same time, clarify the docs a bit for Perl_sort() and
Perl_sort_flags()
Diffstat (limited to 'pp_sort.c')
| -rw-r--r-- | pp_sort.c | 7 |
1 files changed, 3 insertions, 4 deletions
@@ -1428,9 +1428,7 @@ S_qsortsv(pTHX_ gptr *list1, size_t nmemb, SVCOMPARE_t cmp, U32 flags) =for apidoc sortsv -Sort an array. Here is an example: - - sortsv(AvARRAY(av), av_top_index(av)+1, Perl_sv_cmp_locale); +In-place sort an array of SV pointers with the given comparison routine. Currently this always uses mergesort. See C<L</sortsv_flags>> for a more flexible routine. @@ -1449,7 +1447,8 @@ Perl_sortsv(pTHX_ SV **array, size_t nmemb, SVCOMPARE_t cmp) /* =for apidoc sortsv_flags -Sort an array, with various options. +In-place sort an array of SV pointers with the given comparison routine, +with various SORTf_* flag options. =cut */ |