From: Andy Grundman <andy@hybridized.org>
Date: Sat, 12 Nov 2005 02:19:56 +0000 (+0000)
Subject: Utils doc patch from ningu
X-Git-Tag: 5.7099_04~950
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=e2cc89a98938400ae5953b6d0ee79742768ed7df

Utils doc patch from ningu
---

diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm
index 8fe7043..c3145d3 100644
--- a/lib/Catalyst/Utils.pm
+++ b/lib/Catalyst/Utils.pm
@@ -23,8 +23,6 @@ See L<Catalyst>.
 
 =item appprefix($class)
 
-Returns the application prefix for the class.
-
 	MyApp::Foo becomes myapp_foo
 
 =cut
@@ -38,8 +36,6 @@ sub appprefix {
 
 =item class2appclass($class);
 
-Returns the appclass for class.
-
     MyApp::C::Foo::Bar becomes MyApp
     My::App::C::Foo::Bar becomes My::App
 
@@ -56,8 +52,6 @@ sub class2appclass {
 
 =item class2classprefix($class);
 
-Returns the classprefix for class.
-
     MyApp::C::Foo::Bar becomes MyApp::C
     My::App::C::Foo::Bar becomes My::App::C
 
@@ -74,8 +68,6 @@ sub class2classprefix {
 
 =item class2classsuffix($class);
 
-Returns the classsuffix for class.
-
     MyApp::C::Foo::Bar becomes C::Foo::Bar
 
 =cut
@@ -104,9 +96,9 @@ sub class2env {
 
 =item class2prefix( $class, $case );
 
-Returns the prefix for class.
+Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
 
-    My::App::C::Foo::Bar becomes /foo/bar
+    My::App::C::Foo::Bar becomes foo/bar
 
 =cut
 
@@ -123,7 +115,7 @@ sub class2prefix {
 
 =item class2tempdir( $class [, $create ] );
 
-Returns a tempdir for class. If create is true it will try to create the path.
+Returns a tempdir for a class. If create is true it will try to create the path.
 
     My::App becomes /tmp/my/app
     My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar
@@ -187,7 +179,7 @@ sub home {
 
 Returns a prefixed action.
 
-    MyApp::C::Foo::Bar, yada becomes /foo/bar/yada
+    MyApp::C::Foo::Bar, yada becomes foo/bar/yada
 
 =cut
 
@@ -198,9 +190,9 @@ sub prefix {
     return $name;
 }
 
-=item request($request)
+=item request($uri)
 
-Returns a HTTP::Request object.
+Returns an L<HTTP::Request> object for a uri.
 
 =cut