documentation tweaks

mojolicious · Oct 1, 2013 · 307d6e1 · 307d6e1
1 parent 8eb3965
commit 307d6e1
Show file tree

Hide file tree

Showing 33 changed files with 84 additions and 86 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,5 @@
 
-4.43  2013-10-01
+4.43  2013-10-02
 
 4.42  2013-09-30
   - Added EXPERIMENTAL form validation support.

diff --git a/lib/Mojo/Asset.pm b/lib/Mojo/Asset.pm
@@ -98,7 +98,7 @@ False.
 
 =head2 is_range
 
-  my $success = $asset->is_range;
+  my $bool = $asset->is_range;
 
 Check if asset has a C<start_range> or C<end_range>.
 

diff --git a/lib/Mojo/ByteStream.pm b/lib/Mojo/ByteStream.pm
@@ -219,7 +219,7 @@ Print bytestream to handle and append a newline, defaults to C<STDOUT>.
 
 =head2 secure_compare
 
-  my $success = $stream->secure_compare($str);
+  my $bool = $stream->secure_compare($str);
 
 Compare bytestream with L<Mojo::Util/"secure_compare">.
 

diff --git a/lib/Mojo/Content.pm b/lib/Mojo/Content.pm
@@ -430,7 +430,7 @@ implements the following new ones.
 
 =head2 body_contains
 
-  my $success = $content->body_contains('foo bar baz');
+  my $bool = $content->body_contains('foo bar baz');
 
 Check if content contains a specific string. Meant to be overloaded in a
 subclass.
@@ -498,32 +498,32 @@ Size of headers in bytes.
 
 =head2 is_chunked
 
-  my $success = $content->is_chunked;
+  my $bool = $content->is_chunked;
 
 Check if content is chunked.
 
 =head2 is_compressed
 
-  my $success = $content->is_compressed;
+  my $bool = $content->is_compressed;
 
 Check if content is C<gzip> compressed.
 
 =head2 is_dynamic
 
-  my $success = $content->is_dynamic;
+  my $bool = $content->is_dynamic;
 
 Check if content will be dynamically generated, which prevents C<clone> from
 working.
 
 =head2 is_finished
 
-  my $success = $content->is_finished;
+  my $bool = $content->is_finished;
 
 Check if parser is finished.
 
 =head2 is_limit_exceeded
 
-  my $success = $content->is_limit_exceeded;
+  my $bool = $content->is_limit_exceeded;
 
 Check if buffer has exceeded C<max_buffer_size>.
 
@@ -535,7 +535,7 @@ False.
 
 =head2 is_parsing_body
 
-  my $success = $content->is_parsing_body;
+  my $bool = $content->is_parsing_body;
 
 Check if body parsing started yet.
 

diff --git a/lib/Mojo/Content/MultiPart.pm b/lib/Mojo/Content/MultiPart.pm
@@ -265,7 +265,7 @@ event with default content parser.
 
 =head2 body_contains
 
-  my $success = $multi->body_contains('foobarbaz');
+  my $bool = $multi->body_contains('foobarbaz');
 
 Check if content parts contain a specific string.
 

diff --git a/lib/Mojo/Content/Single.pm b/lib/Mojo/Content/Single.pm
@@ -127,7 +127,7 @@ with default content parser.
 
 =head2 body_contains
 
-  my $success = $single->body_contains('1234567');
+  my $bool = $single->body_contains('1234567');
 
 Check if content contains a specific string.
 

diff --git a/lib/Mojo/DOM/CSS.pm b/lib/Mojo/DOM/CSS.pm
@@ -613,7 +613,7 @@ following new ones.
 
 =head2 match
 
-  my $success = $css->match('head > title');
+  my $bool = $css->match('head > title');
 
 Match CSS selector against first node in C<tree>.
 

diff --git a/lib/Mojo/EventEmitter.pm b/lib/Mojo/EventEmitter.pm
@@ -156,7 +156,7 @@ Emit event safely and emit C<error> event on failure.
 
 =head2 has_subscribers
 
-  my $success = $e->has_subscribers('foo');
+  my $bool = $e->has_subscribers('foo');
 
 Check if event has subscribers.
 

diff --git a/lib/Mojo/Headers.pm b/lib/Mojo/Headers.pm
@@ -411,13 +411,13 @@ Shortcut for the C<If-Modified-Since> header.
 
 =head2 is_finished
 
-  my $success = $headers->is_finished;
+  my $bool = $headers->is_finished;
 
 Check if header parser is finished.
 
 =head2 is_limit_exceeded
 
-  my $success = $headers->is_limit_exceeded;
+  my $bool = $headers->is_limit_exceeded;
 
 Check if a header has exceeded C<max_line_size>.
 

diff --git a/lib/Mojo/IOLoop.pm b/lib/Mojo/IOLoop.pm
@@ -480,8 +480,8 @@ Find a free TCP port, this is a utility function primarily used for tests.
 
 =head2 is_running
 
-  my $success = Mojo::IOLoop->is_running;
-  my $success = $loop->is_running;
+  my $bool = Mojo::IOLoop->is_running;
+  my $bool = $loop->is_running;
 
 Check if event loop is running.
 

diff --git a/lib/Mojo/IOLoop/Stream.pm b/lib/Mojo/IOLoop/Stream.pm
@@ -277,14 +277,14 @@ Get handle for stream.
 
 =head2 is_readable
 
-  my $success = $stream->is_readable;
+  my $bool = $stream->is_readable;
 
 Quick non-blocking check if stream is readable, useful for identifying tainted
 sockets.
 
 =head2 is_writing
 
-  my $success = $stream->is_writing;
+  my $bool = $stream->is_writing;
 
 Check if stream is writing.
 

diff --git a/lib/Mojo/JSON/Pointer.pm b/lib/Mojo/JSON/Pointer.pm
@@ -53,7 +53,7 @@ L<Mojo::JSON::Pointer> is a relaxed implementation of RFC 6901.
 
 =head2 contains
 
-  my $success = $pointer->contains($data, '/foo/1');
+  my $bool = $pointer->contains($data, '/foo/1');
 
 Check if data structure contains a value that can be identified with the given
 JSON Pointer.

diff --git a/lib/Mojo/Loader.pm b/lib/Mojo/Loader.pm
@@ -122,7 +122,7 @@ Extract embedded file from the C<DATA> section of a class.
 
 =head2 is_binary
 
-  my $success = $loader->is_binary('Foo::Bar', 'test.png');
+  my $bool = $loader->is_binary('Foo::Bar', 'test.png');
 
 Check if embedded file from the C<DATA> section of a class was Base64 encoded.
 

diff --git a/lib/Mojo/Log.pm b/lib/Mojo/Log.pm
@@ -208,37 +208,37 @@ Log info message.
 
 =head2 is_level
 
-  my $success = $log->is_level('debug');
+  my $bool = $log->is_level('debug');
 
 Check log level.
 
 =head2 is_debug
 
-  my $success = $log->is_debug;
+  my $bool = $log->is_debug;
 
 Check for debug log level.
 
 =head2 is_error
 
-  my $success = $log->is_error;
+  my $bool = $log->is_error;
 
 Check for error log level.
 
 =head2 is_fatal
 
-  my $success = $log->is_fatal;
+  my $bool = $log->is_fatal;
 
 Check for fatal log level.
 
 =head2 is_info
 
-  my $success = $log->is_info;
+  my $bool = $log->is_info;
 
 Check for info log level.
 
 =head2 is_warn
 
-  my $success = $log->is_warn;
+  my $bool = $log->is_warn;
 
 Check for warn log level.
 

diff --git a/lib/Mojo/Message.pm b/lib/Mojo/Message.pm
@@ -503,7 +503,7 @@ Error and code.
 
 =head2 extract_start_line
 
-  my $success = $msg->extract_start_line(\$str);
+  my $bool = $msg->extract_start_line(\$str);
 
 Extract start line from string. Meant to be overloaded in a subclass.
 
@@ -552,13 +552,13 @@ Message headers, usually a L<Mojo::Headers> object.
 
 =head2 is_finished
 
-  my $success = $msg->is_finished;
+  my $bool = $msg->is_finished;
 
 Check if message parser/generator is finished.
 
 =head2 is_limit_exceeded
 
-  my $success = $msg->is_limit_exceeded;
+  my $bool = $msg->is_limit_exceeded;
 
 Check if message has exceeded C<max_line_size> or C<max_message_size>.
 

diff --git a/lib/Mojo/Message/Request.pm b/lib/Mojo/Message/Request.pm
@@ -353,7 +353,7 @@ Access request cookies, usually L<Mojo::Cookie::Request> objects.
 
 =head2 extract_start_line
 
-  my $success = $req->extract_start_line(\$str);
+  my $bool = $req->extract_start_line(\$str);
 
 Extract request line from string.
 
@@ -371,13 +371,13 @@ Get a chunk of request line data starting from a specific position.
 
 =head2 is_secure
 
-  my $success = $req->is_secure;
+  my $bool = $req->is_secure;
 
 Check if connection is secure.
 
 =head2 is_xhr
 
-  my $success = $req->is_xhr;
+  my $bool = $req->is_xhr;
 
 Check C<X-Requested-With> header for C<XMLHttpRequest> value.
 

diff --git a/lib/Mojo/Message/Response.pm b/lib/Mojo/Message/Response.pm
@@ -216,7 +216,7 @@ Generate default response message for code.
 
 =head2 extract_start_line
 
-  my $success = $res->extract_start_line(\$str);
+  my $bool = $res->extract_start_line(\$str);
 
 Extract status line from string.
 
@@ -234,13 +234,13 @@ Get a chunk of status line data starting from a specific position.
 
 =head2 is_empty
 
-  my $success = $res->is_empty;
+  my $bool = $res->is_empty;
 
 Check if this is a C<1xx>, C<204> or C<304> response.
 
 =head2 is_status_class
 
-  my $success = $res->is_status_class(200);
+  my $bool = $res->is_status_class(200);
 
 Check response status class.
 

diff --git a/lib/Mojo/Path.pm b/lib/Mojo/Path.pm
@@ -200,7 +200,7 @@ Clone path.
 
 =head2 contains
 
-  my $success = $path->contains('/i/♥/mojolicious');
+  my $bool = $path->contains('/i/♥/mojolicious');
 
 Check if path contains given prefix.
 

diff --git a/lib/Mojo/Reactor.pm b/lib/Mojo/Reactor.pm
@@ -121,14 +121,14 @@ readable or writable. Meant to be overloaded in a subclass.
 
 =head2 is_readable
 
-  my $success = $reactor->is_readable($handle);
+  my $bool = $reactor->is_readable($handle);
 
 Quick non-blocking check if a handle is readable, useful for identifying
 tainted sockets.
 
 =head2 is_running
 
-  my $success = $reactor->is_running;
+  my $bool = $reactor->is_running;
 
 Check if reactor is running. Meant to be overloaded in a subclass.
 
@@ -156,8 +156,8 @@ amount of time in seconds. Meant to be overloaded in a subclass.
 
 =head2 remove
 
-  my $success = $reactor->remove($handle);
-  my $success = $reactor->remove($id);
+  my $bool = $reactor->remove($handle);
+  my $bool = $reactor->remove($id);
 
 Remove handle or timer. Meant to be overloaded in a subclass.
 

diff --git a/lib/Mojo/Reactor/EV.pm b/lib/Mojo/Reactor/EV.pm
@@ -129,7 +129,7 @@ Restart active timer.
 
 =head2 is_running
 
-  my $success = $reactor->is_running;
+  my $bool = $reactor->is_running;
 
 Check if reactor is running.
 

diff --git a/lib/Mojo/Reactor/Poll.pm b/lib/Mojo/Reactor/Poll.pm
@@ -182,7 +182,7 @@ readable or writable.
 
 =head2 is_running
 
-  my $success = $reactor->is_running;
+  my $bool = $reactor->is_running;
 
 Check if reactor is running.
 
@@ -202,8 +202,8 @@ amount of time in seconds.
 
 =head2 remove
 
-  my $success = $reactor->remove($handle);
-  my $success = $reactor->remove($id);
+  my $bool = $reactor->remove($handle);
+  my $bool = $reactor->remove($id);
 
 Remove handle or timer.
 

diff --git a/lib/Mojo/Server/Morbo.pm b/lib/Mojo/Server/Morbo.pm
@@ -155,7 +155,7 @@ the following new ones.
 
 =head2 check_file
 
-  my $success = $morbo->check_file('/home/sri/lib/MyApp.pm');
+  my $bool = $morbo->check_file('/home/sri/lib/MyApp.pm');
 
 Check if file has been modified since last check.
 

diff --git a/lib/Mojo/Transaction.pm b/lib/Mojo/Transaction.pm
@@ -212,7 +212,7 @@ Error and code.
 
 =head2 is_finished
 
-  my $success = $tx->is_finished;
+  my $bool = $tx->is_finished;
 
 Check if transaction is finished.
 
@@ -224,7 +224,7 @@ False.
 
 =head2 is_writing
 
-  my $success = $tx->is_writing;
+  my $bool = $tx->is_writing;
 
 Check if transaction is writing.