Skip Menu |

This queue is for tickets about the POE-Component-IRC CPAN distribution.

Report information
The Basics
Id: 69707
Status: resolved
Priority: 0/
Queue: POE-Component-IRC

People
Owner: Nobody in particular
Requestors: themidnightoker [...] googlemail.com
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: Documentation issue
Date: Sat, 23 Jul 2011 01:48:08 +0100
To: bugs-POE-Component-IRC [...] rt.cpan.org
From: Daniel Fligg <themidnightoker [...] googlemail.com>
Hi there. I have been hacking my way through the POE::Component::IRC module with great success, until I tried to implement formatting in a privmsg. As I didn't realise I had to include IRC::Utils I ended up with silly error messages and had to ask in #perl. Possibly the following documentation could be updated to point out that you need to _include IRC::Util_ rather than just "Have a look at the constants in IRC::Utils <http://search.cpan.org/perldoc?IRC%3A%3AUtils> if you would like to use formatting and color codes in your messages." http://search.cpan.org/dist/POE-Component-IRC/lib/POE/Component/IRC.pm#privmsg I appreciate this down to my own ignorance rather than anything, but it seems from the chat room that I'm not the only one to do such a silly thing. Many thanks, Daniel Fligg
I added a code example to the documentation, showing how the constants are used. It'll be in the next release. https://github.com/bingos/poe-component-irc/commit/e295cfde5da2f25c3a074be8e59ef8141cc128ec