Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-19 08:59:27 +01:00
Code Issues Projects Releases Wiki Activity
833af36b08
Limnoria/plugins/Plugin
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
__init__.py Use importlib instead of imp. 2020-01-26 12:00:08 +01:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot PluginDownloader: update l10n-fi. 2014-03-22 16:38:16 +02:00
plugin.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py All plugins: set Limnoria contributors as maintainer 2019-11-16 11:41:13 -08:00

README.rst

Documentation for the Plugin plugin for Supybot

Purpose

This plugin handles various plugin-related things, such as getting help for a plugin or retrieving author info.

Usage

This plugin exists to help users manage their plugins. Use 'plugin list' to list the loaded plugins; use 'plugin help' to get the description of a plugin; use the 'plugin' command itself to determine what plugin a command exists in.

Commands

author <plugin>

Returns the author of <plugin>. This is the person you should talk to if you have ideas, suggestions, or other comments about a given plugin.

contributors <plugin> [<name>]

Replies with a list of people who made contributions to a given plugin. If <name> is specified, that person's specific contributions will be listed. You can specify a person's name by their full name or their nick, which is shown inside brackets if available.

help <plugin>

Returns a useful description of how to use <plugin>, if the plugin has one.

plugin <command>

Returns the name of the plugin that would be used to call <command>. If it is not uniquely determined, returns list of all plugins that contain <command>.

plugins <command>

Returns the names of all plugins that contain <command>.

Configuration

supybot.plugins.Plugin.public

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

Determines whether this plugin is publicly visible.