mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01:00

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

1.7 KiB

Raw Blame History

Documentation for the Quote plugin for Supybot

Purpose

Maintains a Quotes database for each channel.

Usage

This plugin allows you to add quotes to the database for a channel.

Commands

add [<channel>] <text>: Adds <text> to the quote database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
change [<channel>] <id> <regexp>: Changes the quote with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.
get [<channel>] <id>: Gets the quote with id <id> from the quote database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
random [<channel>]: Returns a random quote from <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
remove [<channel>] <id>: Removes the quote with id <id> from the quote database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
replace [<channel>] <id> <text>: Replace quote <id> with <text>. <channel> is only necessary if the message isn't sent in the channel itself.
search [<channel>] [--{regexp,by} <value>] [<glob>]: Searches for quotes matching the criteria given.
stats [<channel>]: Returns the number of quotes in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

Configuration

supybot.plugins.Quote.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

1.7 KiB Raw Blame History