mirror of https://github.com/Mikaela/Limnoria.git synced 2024-10-06 19:38:50 +02: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

2.1 KiB

Raw Blame History

Documentation for the Praise plugin for Supybot

Purpose

Hand out praise to IRC denizens with this plugin.

Usage

Praise is a plugin for ... well, praising things. Feel free to add your own flavor to it by customizing what praises it gives. Use "praise add <text>" to add new ones, making sure to include "$who" in <text> where you want to insert the thing being praised.

Example:

If you add hugs $who
Someone says @praise ChanServ.
* bot hugs ChanServ

Commands

add [<channel>] <text>: Adds <text> to the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
change [<channel>] <id> <regexp>: Changes the praise 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 praise with id <id> from the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

praise [<channel>] [<id>] <whowhat> (for <reason>, if given). If <id> is given, uses that specific praise. <channel> is only necessary if the message isn't sent in the channel itself.

remove [<channel>] <id>: Removes the praise with id <id> from the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
search [<channel>] [--{regexp,by} <value>] [<glob>]: Searches for praises matching the criteria given.
stats [<channel>]: Returns the number of praises in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

Configuration

supybot.plugins.Praise.public

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

Determines whether this plugin is publicly visible.

supybot.plugins.Praise.showIds

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

Determines whether the bot will show the ids of a praise when the praise is given.

2.1 KiB Raw Blame History