From: Tomas Doran <bobtfish@bobtfish.net>
Date: Tue, 17 Feb 2009 01:33:49 +0000 (+0000)
Subject: Add POD for setup_actions method in dispatcher, slight whitespace cleanups. Re-write... 
X-Git-Tag: 5.80001~94
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=8f5a2bd91034f630162e41661d559095e4ec7a01

Add POD for setup_actions method in dispatcher, slight whitespace cleanups. Re-write docs about dispatcher method deprecation
---

diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index ae8946f..14fbe14 100644
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -101,7 +101,6 @@ it with a C<+>, like so:
 Delegate the dispatch to the action that matched the url, or return a
 message about unknown resource
 
-
 =cut
 
 sub dispatch {
@@ -109,7 +108,6 @@ sub dispatch {
     if ( my $action = $c->action ) {
         $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
     }
-
     else {
         my $path  = $c->req->path;
         my $error = $path
@@ -472,7 +470,7 @@ sub uri_for_action {
     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 @@ sub _find_or_create_namespace_node {
 
 =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;
diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod
index 7c454b3..5918872 100644
--- a/lib/Catalyst/Upgrading.pod
+++ b/lib/Catalyst/Upgrading.pod
@@ -204,9 +204,9 @@ method in your @ISA.
 
 =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 @@ The first time one of these methods is called, a warning will be emitted:
 
 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.