updating docs to be more clear about behavior when updating

thanks to LTJake for feedback

diff --git a/lib/Catalyst/Authentication/Store/DBIx/Class/User.pm b/lib/Catalyst/Authentication/Store/DBIx/Class/User.pm
index a4f0222..e77b717 100644 (file)
--- a/lib/Catalyst/Authentication/Store/DBIx/Class/User.pm
+++ b/lib/Catalyst/Authentication/Store/DBIx/Class/User.pm
@@ -267,11 +267,12 @@ with this object. It is up to you to implement that method.
 This is called when the auto_update_user option is turned on in
 Catalyst::Plugin::Authentication. Note that by default the DBIx::Class store
 uses every field in the authinfo hash to match the user. This means any
-information that is provided that does not match the user record will cause
-the user record to not be found. In order for the auto_update routine to be
-useful, you have to add the fields you wish to update to the
-'ignore_fields_in_find' authinfo element, or you must be using one of the advanced row
-retrieval methods (searchargs or resultset).
+information you provide with the intent to update must be ignored during the
+user search process. Otherwise the information will most likely cause the user
+record to not be found. To ignore fields in the search process, you
+have to add the fields you wish to update to the 'ignore_fields_in_find'
+authinfo element.  Alternately, you can use one of the advanced row retrieval
+methods (searchargs or resultset).
 
 By default, auto_update will call the C<auto_update()> method of the
 DBIx::Class::Row object associated with the user. It is up to you to implement