.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::Subroutines::ProhibitReturnSort 3pm"
.TH Perl::Critic::Policy::Subroutines::ProhibitReturnSort 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::Subroutines::ProhibitReturnSort \- Behavior of "sort" is not defined if called in scalar context.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The behavior of the builtin \f(CW\*(C`sort\*(C'\fR function is not defined if called
in scalar context.  So if you write a subroutine that directly
\&\f(CW\*(C`return\*(C'\fRs the result of a \f(CW\*(C`sort\*(C'\fR operation, then your code will
behave unpredictably if someone calls your subroutine in a scalar
context.  This Policy emits a violation if the \f(CW\*(C`return\*(C'\fR keyword
is directly followed by the \f(CW\*(C`sort\*(C'\fR function.  To safely return a
sorted list of values from a subroutine, you should assign the
sorted values to a temporary variable first.  For example:
.PP
.Vb 1
\&   sub frobulate {
\&
\&       return sort @list;  # not ok!
\&
\&       my @sorted_list = sort @list;
\&       return @sorted_list # OK
\&   }
.Ve
.SH "KNOWN BUGS"
.IX Header "KNOWN BUGS"
This Policy is not sensitive to the \f(CW\*(C`wantarray\*(C'\fR function.  So the
following code would generate a false violation:
.PP
.Vb 1
\&   sub frobulate {
\&
\&       if (wantarray) {
\&           return sort @list;
\&       }
\&       else{
\&           return join @list;
\&       }
\&   }
.Ve
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This Policy is not configurable except for the standard options.
.SH CREDITS
.IX Header "CREDITS"
This Policy was suggested by Ulrich Wisser and the <http://iis.se> team.
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2017 Imaginative Software Systems.  All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module.