[Catalyst-commits] r13044 - in trunk/Catalyst-Plugin-Unicode: . lib/Catalyst/Plugin

[t0m at dev.catalyst.perl.org]

Author: t0m
Date: 2010-03-17 22:32:38 +0000 (Wed, 17 Mar 2010)
New Revision: 13044

Modified:
   trunk/Catalyst-Plugin-Unicode/Changes
   trunk/Catalyst-Plugin-Unicode/lib/Catalyst/Plugin/Unicode.pm
Log:
Make docs more clear

Modified: trunk/Catalyst-Plugin-Unicode/Changes
===================================================================
--- trunk/Catalyst-Plugin-Unicode/Changes	2010-03-17 16:17:59 UTC (rev 13043)
+++ trunk/Catalyst-Plugin-Unicode/Changes	2010-03-17 22:32:38 UTC (rev 13044)
@@ -1,5 +1,9 @@
 Revision history for Perl extension Catalyst::Plugin::Unicode
 
+0.93 Wed Mar 17 22:35:00 GMT 2010
+        - Make the documentation be phrased much more strongly
+          about how this is not the preferred unicode module.
+
 0.92 Sun Oct  4 18:30:00 GMT 2009
         - Add documentation note that you probably want to use
           Catalyst::Plugin::Unicode::Encoding

Modified: trunk/Catalyst-Plugin-Unicode/lib/Catalyst/Plugin/Unicode.pm
===================================================================
--- trunk/Catalyst-Plugin-Unicode/lib/Catalyst/Plugin/Unicode.pm	2010-03-17 16:17:59 UTC (rev 13043)
+++ trunk/Catalyst-Plugin-Unicode/lib/Catalyst/Plugin/Unicode.pm	2010-03-17 22:32:38 UTC (rev 13044)
@@ -4,7 +4,7 @@
 
 use MRO::Compat;
 
-our $VERSION = '0.92';
+our $VERSION = '0.93';
 
 sub finalize {
     my $c = shift;
@@ -37,29 +37,33 @@
 
 =head1 NAME
 
-Catalyst::Plugin::Unicode - Unicode aware Catalyst
+Catalyst::Plugin::Unicode - Unicode aware Catalyst (old style)
 
 =head1 SYNOPSIS
 
+    # DO NOT USE THIS - Use Catalyst::Plugin::Unicode::Encoding instead
+    #                   which is both more correct, and handles more cases.
     use Catalyst qw[Unicode];
 
-
 =head1 DESCRIPTION
 
 On request, decodes all params from UTF-8 octets into a sequence of
 logical characters. On response, encodes body into UTF-8 octets.
 
 Note that this plugin tries to autodetect if your response is encoded into
-characters before trying to encode it into a byte stream. This is bad
+characters before trying to encode it into a byte stream. This is B<bad>
 as sometimes it can guess wrongly and cause problems.
 
 As an example, latin1 characters such as é (e-accute) will not actually
 cause the output to be encoded as utf8.
 
-Using L<Catalyst::Plugin::Unicode::Encoding> is more recommended, but that
-requires that all data inputs have correctly been decoded into perl's
-internal character representation.
+Using L<Catalyst::Plugin::Unicode::Encoding> is much more recommended,
+and that also does additional things (like decoding file upload filenames
+and request parameters which this plugin does not).
 
+This plugin should be considered deprecated, but is maintained as a large
+number of applications are using it already.
+
 =head1 OVERLOADED METHODS
 
 =over 4