[Catalyst-commits] r9318 - Catalyst-Runtime/5.80/trunk/lib/Catalyst

[t0m at dev.catalyst.perl.org]

Author: t0m
Date: 2009-02-17 01:33:49 +0000 (Tue, 17 Feb 2009)
New Revision: 9318

Modified:
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/Dispatcher.pm
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod
Log:
Add POD for setup_actions method in dispatcher, slight whitespace cleanups. Re-write docs about dispatcher method deprecation

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/Dispatcher.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/Dispatcher.pm	2009-02-16 22:52:50 UTC (rev 9317)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/Dispatcher.pm	2009-02-17 01:33:49 UTC (rev 9318)
@@ -101,7 +101,6 @@
 Delegate the dispatch to the action that matched the url, or return a
 message about unknown resource
 
-
 =cut
 
 sub dispatch {
@@ -109,7 +108,6 @@
     if ( my $action = $c->action ) {
         $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
     }
-
     else {
         my $path  = $c->req->path;
         my $error = $path
@@ -472,7 +470,7 @@
     return undef;
 }
 
-=head2 expand_action 
+=head2 expand_action
 
 expand an action into a full representation of the dispatch.
 mostly useful for chained, other actions will just return a
@@ -564,13 +562,14 @@
 
 =head2 $self->setup_actions( $class, $context )
 
+Loads all of the preload dispatch types, registers their actions and then
+loads all of the postload dispatch types, and does dispatcher initialization.
 
 =cut
 
 sub setup_actions {
     my ( $self, $c ) = @_;
 
-
     my @classes =
       $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
     @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod	2009-02-16 22:52:50 UTC (rev 9317)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod	2009-02-17 01:33:49 UTC (rev 9318)
@@ -204,9 +204,9 @@
 
 =head2 Methods in Catalyst::Dispatcher
 
-The following methods in Catalyst::Dispatcher are likely to change
-significantly in the 5.8X release series, and therefore their use is highly
-deprecated.
+The following methods in Catalyst::Dispatcher are both an implementation detail,
+and also likely to change significantly in the 5.8X release series, and therefore 
+their use is highly deprecated.
 
 =over
 
@@ -231,9 +231,10 @@
 
 You should B<NEVER> be calling any of these methods from application code.
 
-Plugins authors and maintainers whos plugins need to call these methods should
-email the development list to discuss your use-case, and what a better API
-should look like.
+Plugins authors and maintainers whos plugins currently call these methods
+should change to using the public API, or, if you do not feel the public API
+adaquately supports your use-case, please email the development list to
+discuss what API features you need so that you can be appropriately supported.
 
 =head2 require $class was successful but the package is not defined.