better descriptions for many object constructors

mojolicious · Apr 23, 2013 · c64c463 · c64c463
1 parent aebb685
commit c64c463
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 17 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,7 @@
 
-3.97  2013-04-23
+3.97  2013-04-24
   - Added data attribute to Mojo::URL.
+  - Improved documentation.
   - Improved tests.
 
 3.96  2013-04-22

diff --git a/lib/Mojo/DOM.pm b/lib/Mojo/DOM.pm
@@ -451,7 +451,8 @@ following new ones.
   my $dom = Mojo::DOM->new;
   my $dom = Mojo::DOM->new('<foo bar="baz">test</foo>');
 
-Construct a new array-based L<Mojo::DOM> object.
+Construct a new array-based L<Mojo::DOM> object and C<parse> HTML/XML document
+if necessary.
 
 =head2 all_text
 

diff --git a/lib/Mojo/Date.pm b/lib/Mojo/Date.pm
@@ -109,7 +109,7 @@ following new ones.
   my $date = Mojo::Date->new;
   my $date = Mojo::Date->new('Sun Nov  6 08:49:37 1994');
 
-Construct a new L<Mojo::Date> object.
+Construct a new L<Mojo::Date> object and C<parse> date if necessary.
 
 =head2 parse
 

diff --git a/lib/Mojo/Home.pm b/lib/Mojo/Home.pm
@@ -113,7 +113,7 @@ following new ones.
   my $home = Mojo::Home->new;
   my $home = Mojo::Home->new('/home/sri/myapp');
 
-Construct a new L<Mojo::Home> object.
+Construct a new L<Mojo::Home> object and C<parse> home directory if necessary.
 
 =head2 detect
 

diff --git a/lib/Mojo/Parameters.pm b/lib/Mojo/Parameters.pm
@@ -245,7 +245,8 @@ following new ones.
   my $params = Mojo::Parameters->new(foo => ['ba;r', 'b;az']);
   my $params = Mojo::Parameters->new(foo => ['ba;r', 'b;az'], bar => 23);
 
-Construct a new L<Mojo::Parameters> object.
+Construct a new L<Mojo::Parameters> object and C<parse> parameters if
+necessary.
 
 =head2 append
 

diff --git a/lib/Mojo/Path.pm b/lib/Mojo/Path.pm
@@ -182,7 +182,7 @@ following new ones.
   my $path = Mojo::Path->new;
   my $path = Mojo::Path->new('/foo%2Fbar%3B/baz.html');
 
-Construct a new L<Mojo::Path> object.
+Construct a new L<Mojo::Path> object and C<parse> path if necessary.
 
 =head2 canonicalize
 

diff --git a/lib/Mojo/Template.pm b/lib/Mojo/Template.pm
@@ -633,12 +633,6 @@ Character activating automatic whitespace trimming, defaults to C<=>.
 L<Mojo::Template> inherits all methods from L<Mojo::Base> and implements the
 following new ones.
 
-=head2 new
-
-  my $mt = Mojo::Template->new;
-
-Construct a new L<Mojo::Template> object.
-
 =head2 build
 
   $mt = $mt->build;

diff --git a/lib/Mojo/URL.pm b/lib/Mojo/URL.pm
@@ -340,7 +340,7 @@ following new ones.
   my $url = Mojo::URL->new;
   my $url = Mojo::URL->new('http://127.0.0.1:3000/foo?f=b&baz=2#foo');
 
-Construct a new L<Mojo::URL> object.
+Construct a new L<Mojo::URL> object and C<parse> URL if necessary.
 
 =head2 authority
 

diff --git a/lib/Mojolicious/Routes/Pattern.pm b/lib/Mojolicious/Routes/Pattern.pm
@@ -368,7 +368,8 @@ implements the following new ones.
     = Mojolicious::Routes::Pattern->new('/:action', action => qr/\w+/);
   my $pattern = Mojolicious::Routes::Pattern->new(format => 0);
 
-Construct a new L<Mojolicious::Routes::Pattern> object.
+Construct a new L<Mojolicious::Routes::Pattern> object and C<parse> pattern if
+necessary.
 
 =head2 match
 
@@ -383,7 +384,7 @@ Match pattern against entire path, format detection is disabled by default.
   $pattern = $pattern->parse('/:action', action => qr/\w+/);
   $pattern = $pattern->parse(format => 0);
 
-Parse a raw pattern.
+Parse pattern.
 
 =head2 render
 

diff --git a/lib/Mojolicious/Routes/Route.pm b/lib/Mojolicious/Routes/Route.pm
@@ -327,7 +327,8 @@ implements the following new ones.
   my $r = Mojolicious::Routes::Route->new;
   my $r = Mojolicious::Routes::Route->new('/:controller/:action');
 
-Construct a new L<Mojolicious::Routes::Route> object.
+Construct a new L<Mojolicious::Routes::Route> object and <parse> pattern if
+necessary.
 
 =head2 add_child
 
@@ -474,7 +475,7 @@ routing cache, since conditions are too complex for caching.
   $r = $r->parse('/:action', action => qr/\w+/);
   $r = $r->parse(format => 0);
 
-Parse a pattern.
+Parse pattern.
 
 =head2 patch