Add notice about proxy turning on raw events

bingos · Apr 10, 2009 · f904611 · f904611
1 parent cfa2388
commit f904611
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/lib/POE/Component/IRC.pm b/lib/POE/Component/IRC.pm
@@ -2651,9 +2651,9 @@ Similar to the above, except some keys will be missing.
 =head3 C<irc_raw>
 
 Enabled by passing C<< Raw => 1 >> to L<C<spawn>|/"spawn"> or
-L<C<connect>|/"connect">, C<ARG0> is the raw IRC string received by the
-component from the IRC server, before it has been mangled by filters and
-such like.
+L<C<connect>|/"connect">, or by calling L<C<raw_events>|/"raw_events"> with
+a true argument. C<ARG0> is the raw IRC string received by the component from
+the IRC server, before it has been mangled by filters and such like.
 
 =head3 C<irc_registered>
 

diff --git a/lib/POE/Component/IRC/Plugin/Proxy.pm b/lib/POE/Component/IRC/Plugin/Proxy.pm
@@ -379,6 +379,10 @@ multiple IRC clients to connect.
 
 Neat, huh? >;o)
 
+This plugin will activate L<POE::Component::IRC|POE::Component::IRC>'s raw
+events (L<C<irc_raw>|POE::Component::IRC/"irc_raw">) by calling
+C<< $irc->raw_events(1) >>.
+
 This plugin requires the IRC component to be
 L<POE::Component::IRC::State|POE::Component::IRC::State> or a subclass thereof.