Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01:00
Code Issues Projects Releases Wiki Activity
4fc6580a09
Limnoria/plugins/Reply
History
Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs 
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.
2021-04-05 17:42:31 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py Use importlib instead of imp. 2020-01-26 12:00:08 +01:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot PluginDownloader: update l10n-fi. 2014-03-22 16:38:16 +02:00
plugin.py ChannelLogger & Format & Karma & Owner & Reply & Status & URL & Unix: Fix typoes. 2011-08-10 11:26:47 +02:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py Replace failUnless/failIf with assertTrue/assertFalse. 2020-01-26 11:14:18 +01:00

README.rst

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.