[libmessage-passing-perl] 07/12: POD tweaks

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to branch master
in repository libmessage-passing-perl.

commit 001ff677f61e0748b39ecfaa1c1595f9e0ea2589
Author: Mateu X Hunter <hunter at missoula.org>
Date:   Fri Sep 13 15:49:45 2013 -0600

    POD tweaks
---
 Changes                                 |    1 +
 README                                  |    6 +++---
 lib/Message/Passing.pm                  |    6 +++---
 lib/Message/Passing/Manual/Concepts.pod |    5 +++--
 lib/Message/Passing/Manual/Cookbook.pod |    5 +++--
 5 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/Changes b/Changes
index 8a7ef4b..3e85014 100644
--- a/Changes
+++ b/Changes
@@ -1,4 +1,5 @@
   - Fix test failures under Perl 5.18
+  - Improve documentation
 
 0.113 2013-08-02T09:25:00+02:00
   - Add Message::Passing::Filter::Mangle for use with Message::Passing::DSL
diff --git a/README b/README
index 3412a26..ef71a4b 100644
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ SYNOPSIS
 
 DESCRIPTION
     A library for building high performance, loosely coupled and
-    reliable/reseliant applications, structured as small services which
+    reliable/resilient applications, structured as small services which
     communicate over the network by passing messages.
 
   BASIC PREMISE
@@ -95,13 +95,13 @@ COMPONENTS
     Message::Passing::Output::STOMP
     Message::Passing::Output::ZeroMQ
     Message::Passing::Output::WebHooks
-    Message::Passing::Output::ElasticSearch - COMING SOON
+    Message::Passing::Output::ElasticSearch -
     (<https://github.com/suretec/Message-Passing-Output-ElasticSearch>)
     Message::Passing::Output::Redis
     Message::Passing::Output::Test
 
 SEE ALSO
-    Message::Passing::Manual - The manual (incomplete currently)!
+    Message::Passing::Manual - The manual (contributions cherished)
     <http://www.slideshare.net/bobtfish/messaging-interoperability-and-log-a
     ggregation-a-new-framework> - Slide deck!
     Log::Message::Structured - For creating your log messages.
diff --git a/lib/Message/Passing.pm b/lib/Message/Passing.pm
index 2a80b8a..02134d8 100644
--- a/lib/Message/Passing.pm
+++ b/lib/Message/Passing.pm
@@ -105,7 +105,7 @@ Message::Passing - a simple way of doing messaging.
 
 =head1 DESCRIPTION
 
-A library for building high performance, loosely coupled and reliable/reseliant applications,
+A library for building high performance, loosely coupled and reliable/resilient applications,
 structured as small services which communicate over the network by passing messages.
 
 =head2 BASIC PREMISE
@@ -215,7 +215,7 @@ Outputs send data to somewhere, i.e. they consume messages.
 
 =item L<Message::Passing::Output::WebHooks>
 
-=item L<Message::Passing::Output::ElasticSearch> - COMING SOON (L<https://github.com/suretec/Message-Passing-Output-ElasticSearch>)
+=item L<Message::Passing::Output::ElasticSearch> - (L<https://github.com/suretec/Message-Passing-Output-ElasticSearch>)
 
 =item L<Message::Passing::Output::Redis>
 
@@ -227,7 +227,7 @@ Outputs send data to somewhere, i.e. they consume messages.
 
 =over
 
-=item L<Message::Passing::Manual> - The manual (incomplete currently)!
+=item L<Message::Passing::Manual> - The manual (contributions cherished)
 
 =item L<http://www.slideshare.net/bobtfish/messaging-interoperability-and-log-aggregation-a-new-framework> - Slide deck!
 
diff --git a/lib/Message/Passing/Manual/Concepts.pod b/lib/Message/Passing/Manual/Concepts.pod
index 0d7c013..82d109b 100644
--- a/lib/Message/Passing/Manual/Concepts.pod
+++ b/lib/Message/Passing/Manual/Concepts.pod
@@ -31,7 +31,7 @@ method on it's output, like this:
 
     $self->output_to->consume($message);
 
-Outputs are expected to compose L<Message::Passing::Role::Input> which provides this attribute, and
+Inputs are expected to compose L<Message::Passing::Role::Input> which provides this attribute, and
 use the C<BUILD> method from L<Moo> to do any work needed to start listening for events.
 
 =head2 FILTER
@@ -49,7 +49,8 @@ method:
         return $message; # Or return undef to drop it
     }
 
-However, if you want or need to, you can however write a filter manually, as:
+
+However, you can write a filter manually as:
 
     with qw/
         Message::Passing::Role::Input
diff --git a/lib/Message/Passing/Manual/Cookbook.pod b/lib/Message/Passing/Manual/Cookbook.pod
index b73b472..91ba96d 100644
--- a/lib/Message/Passing/Manual/Cookbook.pod
+++ b/lib/Message/Passing/Manual/Cookbook.pod
@@ -43,13 +43,14 @@ output yourself:
 
     my $log = Message::Passing::Output::ZeroMQ->new(
         connect => 'tcp://192.168.0.1:5558',
+        linger  => 1,  # make sure message is sent (flushed) before thread dies
     );
     $log->consume("A log message");
 
 =head2 A note about outputs
 
-Outputting messages from within your application using L<Message::Passing> outputs B<except>
-the ZeroMQ output is not recommended. This is as ZeroMQ uses a different (POSIX) thread with which to send
+ZeroMQ is the recommended B<output> for sending messages from within your application.
+This is because ZeroMQ uses a different (POSIX) thread to send
 messages - meaning that it transports messages independently to whatever
 your perl code is doing.
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libmessage-passing-perl.git