Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Limnoria/plugins/Lart
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
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
__init__.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py Remove first person modification of the reason clause and add tests to support it. 2006-11-13 20:27:23 +00:00

README.rst

Documentation for the Lart plugin for Supybot

Purpose

This plugin keeps a database of larts (Luser Attitude Readjustment Tool), and larts with it.

Usage

Provides an implementation of the Luser Attitude Readjustment Tool for users.

Example:

  • If you add slaps $who.
  • And Someone says @lart ChanServ.
  • * bot slaps ChanServ.

Commands

add [<channel>] <text>

Adds <text> to the lart database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

change [<channel>] <id> <regexp>

Changes the lart 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 lart with id <id> from the lart database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

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

remove [<channel>] <id>

Removes the lart with id <id> from the lart 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 larts matching the criteria given.

stats [<channel>]

Returns the number of larts in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

Configuration

supybot.plugins.Lart.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.Lart.showIds

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

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