Skip to content

Commit

Permalink
supybot-plugin-doc: Add missing newlines + regenerate all READMEs.
Browse files Browse the repository at this point in the history
  • Loading branch information
progval committed Dec 4, 2021
1 parent ef0cd48 commit 828fff9
Show file tree
Hide file tree
Showing 70 changed files with 216 additions and 7 deletions.
3 changes: 3 additions & 0 deletions plugins/Admin/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ Documentation for the Admin plugin for Supybot

Purpose
-------

These are commands useful for administrating the bot; they all require their
caller to have the 'admin' capability. This plugin is loaded by default.

Usage
-----

This plugin provides access to administrative commands, such as
adding capabilities, managing ignore lists, and joining channels.
This is a core Supybot plugin that should not be removed!
Expand All @@ -18,6 +20,7 @@ This is a core Supybot plugin that should not be removed!

Commands
--------

.. _command-admin-acmd:

acmd <command> [<arg> ...]
Expand Down
3 changes: 3 additions & 0 deletions plugins/Aka/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ Documentation for the Aka plugin for Supybot

Purpose
-------

This plugin allows the user to create various aliases (known as "Akas", since
Alias is the name of another plugin Aka is based on) to other commands or
combinations of other commands (via nested commands).

Usage
-----

This plugin allows users to define aliases to commands and combinations
of commands (via nesting).

Expand Down Expand Up @@ -76,6 +78,7 @@ reply with the same information, the result of those commands.

Commands
--------

.. _command-aka-add:

add [--channel <#channel>] <name> <command>
Expand Down
3 changes: 3 additions & 0 deletions plugins/Alias/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ Documentation for the Alias plugin for Supybot

Purpose
-------

Allows aliases for other commands. NOTE THAT IT'S RECOMMENDED TO USE Aka
PLUGIN INSTEAD!

Usage
-----

This plugin allows users to define aliases to commands and combinations
of commands (via nesting).
This plugin is only kept for backward compatibility, you should use the
Expand All @@ -36,6 +38,7 @@ reply with the same information, the result of those commands.

Commands
--------

.. _command-alias-add:

add <name> <command>
Expand Down
3 changes: 3 additions & 0 deletions plugins/Anonymous/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ Documentation for the Anonymous plugin for Supybot

Purpose
-------

Allows folks to talk through the bot anonymously.

Usage
-----

This plugin allows users to act through the bot anonymously. The 'do'
command has the bot perform an anonymous action in a given channel, and
the 'say' command allows other people to speak through the bot. Since
Expand Down Expand Up @@ -48,6 +50,7 @@ This

Commands
--------

.. _command-anonymous-do:

do <channel> <action>
Expand Down
2 changes: 2 additions & 0 deletions plugins/AutoMode/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ Documentation for the AutoMode plugin for Supybot

Purpose
-------

Automatically ops, voices, or halfops, or bans people when they join a channel,
according to their capabilities. If you want your bot automatically op users
when they join your channel, this is the plugin to load.

Usage
-----

This plugin, when configured, allows the bot to automatically set modes
on users when they join.

Expand Down
2 changes: 2 additions & 0 deletions plugins/Autocomplete/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Documentation for the Autocomplete plugin for Supybot

Purpose
-------

Autocomplete: Provides command autocompletion for IRC clients that support it.

This plugin implements an early draft of the IRCv3 autocompletion client tags.
Expand All @@ -17,6 +18,7 @@ If you are interested in this feature, please contribute to

Usage
-----

Provides command completion for IRC clients that support it.

.. _conf-Autocomplete:
Expand Down
3 changes: 3 additions & 0 deletions plugins/BadWords/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ Documentation for the BadWords plugin for Supybot

Purpose
-------

Filters bad words on outgoing messages from the bot, so the bot can't be made
to say bad words.
As an additional capability, it can (optionally) kick users who
use such words from channels that have that capability enabled.

Usage
-----

Maintains a list of words that the bot is not allowed to say.
Can also be used to kick people that say these words, if the bot
has op.
Expand All @@ -20,6 +22,7 @@ has op.

Commands
--------

.. _command-badwords-add:

add <word> [<word> ...]
Expand Down
3 changes: 3 additions & 0 deletions plugins/Channel/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ Documentation for the Channel plugin for Supybot

Purpose
-------

Basic channel management commands. Many of these commands require their caller
to have the #channel,op capability. This plugin is loaded by default.

Usage
-----

This plugin provides various commands for channel management, such
as setting modes and channel-wide bans/ignores/capabilities. This is
a core Supybot plugin that should not be removed!
Expand All @@ -18,6 +20,7 @@ a core Supybot plugin that should not be removed!

Commands
--------

.. _command-channel-alert:

alert [<channel>] <text>
Expand Down
12 changes: 11 additions & 1 deletion plugins/ChannelLogger/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ Documentation for the ChannelLogger plugin for Supybot

Purpose
-------

Logs each channel to its own individual logfile.

Usage
-----

This plugin allows the bot to log channel conversations to disk.

.. _conf-ChannelLogger:
Expand Down Expand Up @@ -112,13 +114,21 @@ supybot.plugins.ChannelLogger.rotateLogs

Determines whether the bot will automatically rotate the logs for this channel. The bot will rotate logs when the timestamp for the log changes. The timestamp is set according to the 'filenameTimestamp' configuration variable.

.. _conf-supybot.plugins.ChannelLogger.showAway:


supybot.plugins.ChannelLogger.showAway
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether users going away and coming back should be logged. This is only supported on networks implementing the 'away-notify' IRCv3 capability.

.. _conf-supybot.plugins.ChannelLogger.showJoinParts:


supybot.plugins.ChannelLogger.showJoinParts
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines wether joins and parts are logged
Determines whether joins and parts are logged

.. _conf-supybot.plugins.ChannelLogger.stripFormatting:

Expand Down
3 changes: 3 additions & 0 deletions plugins/ChannelStats/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,22 @@ Documentation for the ChannelStats plugin for Supybot

Purpose
-------

Silently listens to every message received on a channel and keeps statistics
concerning joins, parts, and various other commands in addition to tracking
statistics about smileys, actions, characters, and words.

Usage
-----

This plugin keeps stats of the channel and returns them with
the command 'channelstats'.

.. _commands-ChannelStats:

Commands
--------

.. _command-channelstats-channelstats:

channelstats [<channel>]
Expand Down
3 changes: 3 additions & 0 deletions plugins/Conditional/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Documentation for the Conditional plugin for Supybot

Purpose
-------

Contains numerous conditional commands (such as 'if', 'and', and 'or'),
which can be used on their own or with another plugin.
Also provides logic operators for writing conditions.
Expand All @@ -13,6 +14,7 @@ Useful for bot scripting / nested commands.

Usage
-----

This plugin provides logic operators and other commands that
enable you to run commands only if a condition is true. Useful for nested
commands and scripting.
Expand All @@ -21,6 +23,7 @@ commands and scripting.

Commands
--------

.. _command-conditional-cand:

cand <cond1> [<cond2> ... <condN>]
Expand Down
3 changes: 3 additions & 0 deletions plugins/Config/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,20 @@ Documentation for the Config plugin for Supybot

Purpose
-------

Handles configuration of the bot while it is running.

Usage
-----

Provides access to the Supybot configuration. This is
a core Supybot plugin that should not be removed!

.. _commands-Config:

Commands
--------

.. _command-config-channel:

channel [<network>] [<channel>] <name> [<value>]
Expand Down
3 changes: 3 additions & 0 deletions plugins/Ctcp/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ Documentation for the Ctcp plugin for Supybot

Purpose
-------

Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO,
and FINGER.

Usage
-----

Provides replies to common CTCPs (version, time, etc.), and a command
to fetch version responses from channels.

Expand All @@ -20,6 +22,7 @@ mode +C or similar which prevents CTCP requests to channel.

Commands
--------

.. _command-ctcp-version:

version [<channel>] [--nicks]
Expand Down
3 changes: 3 additions & 0 deletions plugins/DDG/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ Documentation for the DDG plugin for Supybot

Purpose
-------

Searches for results on DuckDuckGo's web search.

Usage
-----

Searches for results on DuckDuckGo.

Example::
Expand All @@ -20,6 +22,7 @@ Example::

Commands
--------

.. _command-ddg-search:

search <text>
Expand Down
3 changes: 3 additions & 0 deletions plugins/Debug/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,22 @@ Documentation for the Debug plugin for Supybot

Purpose
-------

This is for developers debugging their plugins; it provides an eval command
as well as some other useful commands.
It should not be loaded with a default installation.

Usage
-----

This plugin provides debugging abilities for Supybot. It
should not be loaded with a default installation.

.. _commands-Debug:

Commands
--------

.. _command-debug-channeldb:

channeldb [<channel>]
Expand Down
3 changes: 3 additions & 0 deletions plugins/Dict/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Documentation for the Dict plugin for Supybot

Purpose
-------

Commands that use the dictd protocol to define words.

In order to use this plugin you must have the following modules
Expand All @@ -14,13 +15,15 @@ installed:

Usage
-----

This plugin provides a function to look up words from different
dictionaries.

.. _commands-Dict:

Commands
--------

.. _command-dict-dict:

dict [<dictionary>] <word>
Expand Down
3 changes: 3 additions & 0 deletions plugins/Dunno/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ Documentation for the Dunno plugin for Supybot

Purpose
-------

The Dunno module is used to spice up the reply when given an invalid command
with random 'I dunno'-like responses. If you want something spicier than
'<x> is not a valid command'-like responses, use this plugin.
Like Success does for the 'The operation succeeded.' reply.

Usage
-----

This plugin was written initially to work with MoobotFactoids, the two
of them to provide a similar-to-moobot-and-blootbot interface for factoids.
Basically, it replaces the standard 'Error: <x> is not a valid command.'
Expand All @@ -24,6 +26,7 @@ responses.

Commands
--------

.. _command-dunno-add:

add [<channel>] <text>
Expand Down
Loading

0 comments on commit 828fff9

Please sign in to comment.