mirror of https://github.com/Mikaela/Limnoria.git synced 2024-10-07 03:48:41 +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

1.9 KiB

Raw Blame History

Documentation for the Utilities plugin for Supybot

Purpose

Various utility commands, mostly useful for manipulating nested commands.

Usage

Provides useful commands for bot scripting / command nesting.

Commands

apply <command> <text>: Tokenizes <text> and calls <command> with the resulting arguments.
countargs <arg> [<arg> ...]: Counts the arguments given.
echo <text>: Returns the arguments given it. Uses our standard substitute on the string(s) given to it; $nick (or $who), $randomNick, $randomInt, $botnick, $channel, $user, $host, $today, $now, and $randomDate are all handled appropriately.
ignore requires no arguments: Does nothing. Useful sometimes for sequencing commands when you don't care about their non-error return values.
last <text> [<text> ...]: Returns the last argument given. Useful when you'd like multiple nested commands to run, but only the output of the last one to be returned.
let <variable> = <value> in <command>: Defines <variable> to be equal to <value> in the <command> and runs the <command>. '=' and 'in' can be omitted.
sample <num> <arg> [<arg> ...]: Randomly chooses <num> items out of the arguments given.
shuffle <arg> [<arg> ...]: Shuffles the arguments given.
sort <arg> [<arg> ...]: Sorts the arguments given.
success [<text>]: Does nothing except to reply with a success message. This is useful when you want to run multiple commands as nested commands, and don't care about their output as long as they're successful. An error, of course, will break out of this command. <text>, if given, will be appended to the end of the success message.

Configuration

supybot.plugins.Utilities.public

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

Determines whether this plugin is publicly visible.

1.9 KiB Raw Blame History