mirror of
https://github.com/progval/Limnoria.git
synced 2025-04-27 13:31:08 -05:00
833af36b08
Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason.
.. _plugin-Reply: Documentation for the Reply plugin for Supybot ============================================== Purpose ------- This plugin contains various commands which elicit certain types of responses from the bot. Usage ----- This plugin contains a few commands that construct various types of replies. Some bot owners would be wise to not load this plugin because it can be easily abused. Commands -------- action <text> Replies with <text> as an action. Use nested commands to your benefit here. notice <text> Replies with <text> in a notice. Use nested commands to your benefit here. If you want a private notice, nest the private command. private <text> Replies with <text> in private. Use nested commands to your benefit here. replies <str> [<str> ...] Replies with each of its arguments <str> in separate replies, depending the configuration of supybot.reply.oneToOne. reply <text> Replies with <text>. Equivalent to the alias, 'echo $nick: $1'. Configuration ------------- supybot.plugins.Reply.public This config variable defaults to "True", is not network-specific, and is not channel-specific. Determines whether this plugin is publicly visible.