unified formatting of all experimental notes

mojolicious · Oct 25, 2011 · 7e518c0 · 7e518c0
1 parent ab40cec
commit 7e518c0
Show file tree

Hide file tree

Showing 24 changed files with 18 additions and 36 deletions.
diff --git a/Changes b/Changes
@@ -1,7 +1,8 @@
 This file documents the revision history for Perl extension Mojolicious.
 
-2.11    2011-10-25 00:00:00
+2.11    2011-10-26 00:00:00
         - Improved Mojo::IOLoop::Stream to only emit close events once.
+        - Improved documentation.
 
 2.10    2011-10-25 00:00:00
         - Added EXPERIMENTAL send_frame method to

diff --git a/lib/Mojo/Cache.pm b/lib/Mojo/Cache.pm
@@ -43,7 +43,6 @@ Mojo::Cache - Naive in-memory cache
 =head1 DESCRIPTION
 
 L<Mojo::Cache> is a naive in-memory cache with size limits.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 ATTRIBUTES

diff --git a/lib/Mojo/Collection.pm b/lib/Mojo/Collection.pm
@@ -101,7 +101,6 @@ Mojo::Collection - Collection
 =head1 DESCRIPTION
 
 L<Mojo::Collection> is a container for collections.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojo/DOM/CSS.pm b/lib/Mojo/DOM/CSS.pm
@@ -479,7 +479,6 @@ Mojo::DOM::CSS - CSS3 selector engine
 =head1 DESCRIPTION
 
 L<Mojo::DOM::CSS> is the CSS3 selector engine used by L<Mojo::DOM>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 SELECTORS

diff --git a/lib/Mojo/DOM/HTML.pm b/lib/Mojo/DOM/HTML.pm
@@ -441,7 +441,6 @@ Mojo::DOM::HTML - HTML5/XML engine
 =head1 DESCRIPTION
 
 L<Mojo::DOM::HTML> is the HTML5/XML engine used by L<Mojo::DOM>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 ATTRIBUTES

diff --git a/lib/Mojo/EventEmitter.pm b/lib/Mojo/EventEmitter.pm
@@ -117,7 +117,6 @@ Mojo::EventEmitter - Event emitter base class
 =head1 DESCRIPTION
 
 L<Mojo::EventEmitter> is a simple base class for event emitting objects.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojo/Headers.pm b/lib/Mojo/Headers.pm
@@ -486,8 +486,6 @@ Parse headers from a hash.
   $headers   = $headers->header('Content-Type' => 'text/plain');
 
 Get or replace the current header values.
-Note that this method is context sensitive and will turn all header lines
-into a single one in scalar context.
 
   # Multiple headers with the same name
   for my $header ($headers->header('Set-Cookie')) {

diff --git a/lib/Mojo/IOLoop/Client.pm b/lib/Mojo/IOLoop/Client.pm
@@ -180,7 +180,6 @@ Mojo::IOLoop::Client - IOLoop socket client
 
 L<Mojo::IOLoop::Client> performs non-blocking socket connections for
 L<Mojo::IOLoop>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 EVENTS

diff --git a/lib/Mojo/IOLoop/Resolver.pm b/lib/Mojo/IOLoop/Resolver.pm
@@ -369,7 +369,6 @@ Mojo::IOLoop::Resolver - IOLoop DNS stub resolver
 
 L<Mojo::IOLoop::Resolver> is a minimalistic non-blocking I/O DNS stub
 resolver used by L<Mojo:IOLoop>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 ATTRIBUTES

diff --git a/lib/Mojo/IOLoop/Server.pm b/lib/Mojo/IOLoop/Server.pm
@@ -282,7 +282,6 @@ Mojo::IOLoop::Server - IOLoop socket server
 
 L<Mojo::IOLoop::Server> accepts incoming socket connections for
 L<Mojo::IOLoop>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 EVENTS

diff --git a/lib/Mojo/IOLoop/Stream.pm b/lib/Mojo/IOLoop/Stream.pm
@@ -172,7 +172,6 @@ Mojo::IOLoop::Stream - IOLoop stream
 
 L<Mojo::IOLoop::Stream> is a container for streaming handles used by
 L<Mojo::IOLoop>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 EVENTS

diff --git a/lib/Mojo/IOLoop/Trigger.pm b/lib/Mojo/IOLoop/Trigger.pm
@@ -53,7 +53,6 @@ Mojo::IOLoop::Trigger - IOLoop trigger
 =head1 DESCRIPTION
 
 L<Mojo::IOLoop::Trigger> is a remote control for L<Mojo::IOLoop>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 EVENTS

diff --git a/lib/Mojo/IOWatcher.pm b/lib/Mojo/IOWatcher.pm
@@ -177,7 +177,6 @@ Mojo::IOWatcher - Non-blocking I/O watcher
 L<Mojo::IOWatcher> is a minimalistic non-blocking I/O watcher and the
 foundation of L<Mojo::IOLoop>.
 L<Mojo::IOWatcher::EV> is a good example for its extensibility.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojo/IOWatcher/EV.pm b/lib/Mojo/IOWatcher/EV.pm
@@ -105,7 +105,6 @@ Mojo::IOWatcher::EV - EV non-blocking I/O watcher
 
 L<Mojo::IOWatcher::EV> is a minimalistic non-blocking I/O watcher with
 C<libev> support.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojo/Server/Morbo.pm b/lib/Mojo/Server/Morbo.pm
@@ -143,6 +143,7 @@ L<Mojo::Server::Morbo> is a full featured self-restart capable non-blocking
 I/O HTTP 1.1 and WebSocket server built around the very well tested and
 reliable L<Mojo::Server::Daemon> with C<IPv6>, C<TLS>, C<Bonjour> and
 C<libev> support.
+Note that this module is EXPERIMENTAL and might change without warning!
 
 To start applications with it you can use the L<morbo> script.
 
@@ -153,8 +154,6 @@ Optional modules L<EV>, L<IO::Socket::IP>, L<IO::Socket::SSL> and
 L<Net::Rendezvous::Publish> are supported transparently and used if
 installed.
 
-Note that this module is EXPERIMENTAL and might change without warning!
-
 =head1 ATTRIBUTES
 
 L<Mojo::Server::Morbo> implements the following attributes.

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -363,7 +363,6 @@ Mojo::Transaction::WebSocket - WebSocket transaction container
 L<Mojo::Transaction::WebSocket> is a container for WebSocket transactions as
 described in
 L<http://www.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-17.txt>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 EVENTS

diff --git a/lib/Mojo/UserAgent/Transactor.pm b/lib/Mojo/UserAgent/Transactor.pm
@@ -282,7 +282,6 @@ Mojo::UserAgent::Transactor - User agent transactor
 
 L<Mojo::UserAgent::Transactor> is the transaction building and manipulation
 framework used by L<Mojo::UserAgent>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojo/Util.pm b/lib/Mojo/Util.pm
@@ -676,7 +676,6 @@ Mojo::Util - Portable utility functions
 =head1 DESCRIPTION
 
 L<Mojo::Util> provides portable utility functions for L<Mojo>.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 FUNCTIONS

diff --git a/lib/Mojolicious.pm b/lib/Mojolicious.pm
@@ -471,62 +471,66 @@ The following events are available and run in the listed order.
 
 Triggered right after the transaction is built and before the HTTP request
 gets parsed, the callbacks of this hook run in the order they were added.
-One use case would be upload progress bars.
-(Passed the transaction and application instances)
 
   $app->hook(after_build_tx => sub {
     my ($tx, $app) = @_;
   });
 
+One use case would be upload progress bars.
+(Passed the transaction and application instances)
+
 =item before_dispatch
 
 Triggered right before the static and routes dispatchers start their work,
 the callbacks of this hook run in the order they were added.
-Very useful for rewriting incoming requests and other preprocessing tasks.
-(Passed the default controller instance)
 
   $app->hook(before_dispatch => sub {
     my $self = shift;
   });
 
+Very useful for rewriting incoming requests and other preprocessing tasks.
+(Passed the default controller instance)
+
 =item after_static_dispatch
 
 Triggered after the static dispatcher determined if a static file should be
 served and before the routes dispatcher starts its work, the callbacks of
 this hook run in reverse order.
-Mostly used for custom dispatchers and postprocessing static file responses.
-(Passed the default controller instance)
 
   $app->hook(after_static_dispatch => sub {
     my $self = shift;
   });
 
+Mostly used for custom dispatchers and postprocessing static file responses.
+(Passed the default controller instance)
+
 =item before_render
 
 Triggered right before the renderer turns the stash into a response, the
 callbacks of this hook run in the order they were added.
-Very useful for making adjustments to the stash right before rendering.
-(Passed the current controller instance and argument hash)
+Note that this hook is EXPERIMENTAL and might change without warning!
 
   $app->hook(before_render => sub {
     my ($self, $args) = @_;
   });
 
-Note that this hook is EXPERIMENTAL and might change without warning!
+Very useful for making adjustments to the stash right before rendering.
+(Passed the current controller instance and argument hash)
 
 =item after_dispatch
 
 Triggered after a response has been rendered, the callbacks of this hook run
 in reverse order.
 Note that this hook can trigger before C<after_static_dispatch> due to its
 dynamic nature.
-Useful for all kinds of postprocessing tasks.
-(Passed the current controller instance)
 
   $app->hook(after_dispatch => sub {
     my $self = shift;
   });
 
+Useful for all kinds of postprocessing tasks.
+(Passed the current controller instance)
+
 =back
 
 =head2 C<plugin>

diff --git a/lib/Mojolicious/Command/cpanify.pm b/lib/Mojolicious/Command/cpanify.pm
@@ -75,7 +75,6 @@ Mojolicious::Command::cpanify - Cpanify command
 =head1 DESCRIPTION
 
 L<Mojolicious::Command::cpanify> is a CPAN uploader.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 ATTRIBUTES

diff --git a/lib/Mojolicious/Command/eval.pm b/lib/Mojolicious/Command/eval.pm
@@ -59,7 +59,6 @@ Mojolicious::Command::eval - Eval command
 =head1 DESCRIPTION
 
 L<Mojolicious::Command::eval> runs code against applications.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 ATTRIBUTES

diff --git a/lib/Mojolicious/Command/generate/plugin.pm b/lib/Mojolicious/Command/generate/plugin.pm
@@ -135,7 +135,6 @@ Mojolicious::Command::generate::plugin - Plugin generator command
 =head1 DESCRIPTION
 
 L<Mojolicious::Command::generate::plugin> is a plugin generator.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 ATTRIBUTES

diff --git a/lib/Mojolicious/Plugin/CallbackCondition.pm b/lib/Mojolicious/Plugin/CallbackCondition.pm
@@ -46,7 +46,6 @@ L<Mojolicious::Plugin::CallbackCondition> is a routes condition for
 callbacks.
 This is a core plugin, that means it is always enabled and its code a good
 example for learning to build new plugins.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojolicious/Plugin/Mount.pm b/lib/Mojolicious/Plugin/Mount.pm
@@ -58,7 +58,6 @@ Mojolicious::Plugin::Mount - Application mount plugin
 
 L<Mojolicious::Plugin::Mount> is a plugin that allows you to mount whole
 L<Mojolicious> applications.
-
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS