Skip Menu |

This queue is for tickets about the Bot-BasicBot-Pluggable CPAN distribution.

Report information
The Basics
Id: 75983
Status: resolved
Priority: 0/
Queue: Bot-BasicBot-Pluggable

People
Owner: Nobody in particular
Requestors: omniminded1 [...] gmail.com
Cc:
AdminCc:

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



Subject: Bot::BasicBot::Pluggable::Module::Infobot Documentation omits variable prefix "user_"
Date: Thu, 22 Mar 2012 14:29:54 -0500
To: bug-Bot-BasicBot-Pluggable [...] rt.cpan.org
From: Michael Alexander <omniminded1 [...] gmail.com>
__SUBJECT__ Bot::BasicBot::Pluggable::Module::Infobot Documentation omits variable prefix "user_" __BODY__ Bot::BasicBot::Pluggable::Module::Infobot VERSION = '0.96' Perl: perl 5, version 12, subversion 2 (v5.12.2 (*)) built for i386-openbsd with 4 registered patches Operating system: OpenBSD 4.9 GENERIC.MP#794 i386 The variables in the documentation are wrong here: https://metacpan.org/module/Bot::BasicBot::Pluggable::Module::Infobot#VARS The variables in the source are all prefixed with "user_". https://metacpan.org/source/DIZ/Bot-BasicBot-Pluggable-0.96/lib/Bot/BasicBot/Pluggable/Module/Infobot.pm#L19 Patch... =head1 VARS =over 4 =item user_min_length Defaults to 3; the minimum length a factoid, or inquiry, must be before recognizing it. =item user_max_length Defaults to 25; the maximum length a factoid, or inquiry, can be before ignoring it. =item user_num_results Defaults to 20; the number of facts to return for "search for <term>" privmsg. =item user_passive_answer Defaults to 0; when enabled, the bot will answer factoids without being addressed. =item user_passive_learn Defaults to 0; when enabled, the bot will learn factoids without being addressed. =item user_require_question Defaults to 1; determines whether the bot requires a question mark before responding to a factoid. When enabled, the question mark is required (ie. "water?"). When disabled, the question mark is entirely optional (ie. "water" would also produce a response). =item user_stopwords A comma-, space-, or pipe- separated list of words the bot should not learn or answer. This prevents such insanity as the learning of "where is the store?" and "how is your mother?" The default list of stopwords contains "here", "how", "it", "something", "that", "this", "what", "when", "where", "which", "who" and "why"). =item user_unknown_responses A pipe-separated list of responses the bot will randomly choose from when it doesn't know the answer to a question. The default list of response contains "Dunno.", "I give up.", "I have no idea.", "No clue. Sorry.", "Search me, bub.", and "Sorry, I don't know." =item user_allow_searching Defaults to 0. Searching on large factoid lists is ... problematic. =item user_http_timeout Time in seconds for an http request to timeout. When this value is set to a very high value, a slow site can disconnect a bot by blocking it. Defaults to 10. =item user_rss_items Maximal numbers of items returns when using RSS feeds. Defaults to 5. =back
Five years later(!)... I've added a note in commit 8d47327 mentioning that they all have the user_ prefix in the store, so they can be modified using the Vars module. I've not added the user_ prefix to each of them in the doco, as the name shown is the name you'd use in a !set command, so I think it's less confusing to use the same names, and just note that they're user-configurable, i.e. have the user_ prefix in the store. Cheers Dave P On 2012-03-22 19:30:10, omniminded1@gmail.com wrote: Show quoted text
> __SUBJECT__ > Bot::BasicBot::Pluggable::Module::Infobot Documentation omits variable > prefix "user_" > > __BODY__ > Bot::BasicBot::Pluggable::Module::Infobot VERSION = '0.96' > Perl: perl 5, version 12, subversion 2 (v5.12.2 (*)) built for i386- > openbsd > with 4 registered patches > Operating system: OpenBSD 4.9 GENERIC.MP#794 i386 > > The variables in the documentation are wrong here: > https://metacpan.org/module/Bot::BasicBot::Pluggable::Module::Infobot#VARS > > The variables in the source are all prefixed with "user_". > https://metacpan.org/source/DIZ/Bot-BasicBot-Pluggable- > 0.96/lib/Bot/BasicBot/Pluggable/Module/Infobot.pm#L19 > > Patch... > > =head1 VARS > > =over 4 > > =item user_min_length > > Defaults to 3; the minimum length a factoid, or inquiry, must be > before > recognizing it. > > =item user_max_length > > Defaults to 25; the maximum length a factoid, or inquiry, can be > before > ignoring it. > > =item user_num_results > > Defaults to 20; the number of facts to return for "search for <term>" > privmsg. > > =item user_passive_answer > > Defaults to 0; when enabled, the bot will answer factoids without > being > addressed. > > =item user_passive_learn > > Defaults to 0; when enabled, the bot will learn factoids without being > addressed. > > =item user_require_question > > Defaults to 1; determines whether the bot requires a question mark > before > responding to a factoid. When enabled, the question mark is required > (ie. > "water?"). > When disabled, the question mark is entirely optional (ie. "water" > would > also > produce a response). > > =item user_stopwords > > A comma-, space-, or pipe- separated list of words the bot should not > learn > or > answer. This prevents such insanity as the learning of "where is the > store?" and > "how is your mother?" The default list of stopwords contains "here", > "how", > "it", > "something", "that", "this", "what", "when", "where", "which", "who" > and > "why"). > > =item user_unknown_responses > > A pipe-separated list of responses the bot will randomly choose from > when it > doesn't know the answer to a question. The default list of response > contains > "Dunno.", "I give up.", "I have no idea.", "No clue. Sorry.", "Search > me, > bub.", > and "Sorry, I don't know." > > =item user_allow_searching > > Defaults to 0. > > Searching on large factoid lists is ... problematic. > > =item user_http_timeout > > Time in seconds for an http request to timeout. When this value is > set to a very high value, a slow site can disconnect a bot by > blocking it. Defaults to 10. > > =item user_rss_items > > Maximal numbers of items returns when using RSS feeds. Defaults to 5. > > =back