better examples for many methods

mojolicious · Jul 19, 2012 · a228918 · a228918
1 parent 21f8513
commit a228918
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 13 deletions.
diff --git a/Changes b/Changes
@@ -1,4 +1,7 @@
 
+3.12  2012-07-20
+  - Improved documentation.
+
 3.11  2012-07-19
   - Added or method to Test::Mojo. (moritz, sri)
   - Added file and serve_asset methods to Mojolicious::Static.

diff --git a/lib/Mojo.pm b/lib/Mojo.pm
@@ -91,7 +91,7 @@ Mojo - Duct tape for the HTML5 web!
 
 Mojo provides a flexible runtime environment for Perl real-time web
 frameworks. It provides all the basic tools and helpers needed to write
-simple web applications and higher level web frameworks such as
+simple web applications and higher level web frameworks, such as
 L<Mojolicious>.
 
 See L<Mojolicious> for more!
@@ -169,7 +169,7 @@ Application configuration.
 
 =head2 C<handler>
 
-  $app->handler($tx);
+  $app->handler(Mojo::Transaction::HTTP->new);
 
 The handler is the main entry point to your application or framework and will
 be called for each new transaction, which will usually be a

diff --git a/lib/Mojo/UserAgent.pm b/lib/Mojo/UserAgent.pm
@@ -987,7 +987,7 @@ append a callback to perform requests non-blocking.
 
 =head2 C<start>
 
-  $ua = $ua->start($tx);
+  my $tx = $ua->start(Mojo::Transaction::HTTP->new);
 
 Process blocking transaction. You can also append a callback to perform
 transactions non-blocking.

diff --git a/lib/Mojo/UserAgent/Transactor.pm b/lib/Mojo/UserAgent/Transactor.pm
@@ -270,7 +270,7 @@ implements the following new ones.
 
 =head2 C<endpoint>
 
-  my ($scheme, $host, $port) = $t->endpoint($tx);
+  my ($scheme, $host, $port) = $t->endpoint(Mojo::Transaction::HTTP->new);
 
 Actual endpoint for transaction.
 
@@ -318,20 +318,20 @@ enforce it by setting the header manually.
 
 =head2 C<peer>
 
-  my ($scheme, $host, $port) = $t->peer($tx);
+  my ($scheme, $host, $port) = $t->peer(Mojo::Transaction::HTTP->new);
 
 Actual peer for transaction.
 
 =head2 C<proxy_connect>
 
-  my $tx = $t->proxy_connect($old);
+  my $tx = $t->proxy_connect(Mojo::Transaction::HTTP->new);
 
 Build L<Mojo::Transaction::HTTP> proxy connect request for transaction if
 possible.
 
 =head2 C<redirect>
 
-  my $tx = $t->redirect($old);
+  my $tx = $t->redirect(Mojo::Transaction::HTTP->new);
 
 Build L<Mojo::Transaction::HTTP> followup request for C<301>, C<302>, C<303>,
 C<307> or C<308> redirect response if possible.

diff --git a/lib/Mojolicious.pm b/lib/Mojolicious.pm
@@ -34,7 +34,7 @@ has static   => sub { Mojolicious::Static->new };
 has types    => sub { Mojolicious::Types->new };
 
 our $CODENAME = 'Rainbow';
-our $VERSION  = '3.11';
+our $VERSION  = '3.12';
 
 # "These old doomsday devices are dangerously unstable.
 #  I'll rest easier not knowing where they are."
@@ -407,16 +407,16 @@ request.
 
 =head2 C<dispatch>
 
-  $app->dispatch($c);
+  $app->dispatch(Mojolicious::Controller->new);
 
 The heart of every Mojolicious application, calls the C<static> and C<routes>
 dispatchers for every request and passes them a L<Mojolicious::Controller>
 object.
 
 =head2 C<handler>
 
-  $app->handler($tx);
-  $app->handler($c);
+  $app->handler(Mojo::Transaction::HTTP->new);
+  $app->handler(Mojolicious::Controller->new);
 
 Sets up the default controller and calls process for every request.
 

diff --git a/lib/Mojolicious/Static.pm b/lib/Mojolicious/Static.pm
@@ -189,6 +189,8 @@ Serve static file for L<Mojolicious::Controller> object.
 Get L<Mojo::Asset::File> or L<Mojo::Asset::Memory> object for a file, relative
 to C<paths> or from C<classes>.
 
+  my $content = $static->file('foo/bar.html')->slurp;
+
 =head2 C<serve>
 
   my $success = $static->serve(Mojolicious::Controller->new, 'foo/bar.html');
@@ -199,8 +201,8 @@ Serve a specific file, relative to C<paths> or from C<classes>.
 
   $static->serve_asset(Mojolicious::Controller->new, Mojo::Asset::File->new);
 
-Serve a L<Mojo::Asset::File> or L<Mojo::Asset::Memory> object with range and
-last modified support.
+Serve a L<Mojo::Asset::File> or L<Mojo::Asset::Memory> object with C<Range>
+and C<If-Modified-Since> support.
 
 =head1 SEE ALSO