Add a BUGS section to Fatal.pm, see bug #38790

p4raw-id: //depot/perl@28040

diff --git a/lib/Fatal.pm b/lib/Fatal.pm
index d1357316038a85b93dded3a40e3301e15d79298d..b939f0cf604467f8fc70e8bbde20410da42a866d 100644 (file)
--- a/lib/Fatal.pm
+++ b/lib/Fatal.pm
@@ -177,6 +177,12 @@ values are ignored.  For example
        # not checked, so error raises an exception
        close FH;
 
+=head1 BUGS
+
+You should not fatalize functions that are called in list context, because this
+module tests whether a function has failed by testing the boolean truth of its
+return value in scalar context.
+
 =head1 AUTHOR
 
 Lionel Cons (CERN).