833af36b08
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. |
||
|---|---|---|
| .. | ||
| local | ||
| README.rst | ||
| __init__.py | ||
| config.py | ||
| plugin.py | ||
| test.py | ||
README.rst
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. As this is not yet a released specification, it does
nothing unless supybot.protocols.irc.experimentalExtensions
is set to True (keep it set to False unless you know what you are
doing).
If you are interested in this feature, please contribute to the discussion
Usage
Provides command completion for IRC clients that support it.
Configuration
- supybot.plugins.Autocomplete.enabled
-
This config variable defaults to "False", is network-specific, and is channel-specific.
Whether the bot should reply to autocomplete requests from clients.
- supybot.plugins.Autocomplete.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.