Limnoria/plugins/Nickometer
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 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 Use a prefix-less help string, don't assume a '@' prefix (#1309) 2017-10-25 21:19:37 +02:00
plugin.py AutoMode, Channel, Nickometer: fix invalid escape sequence DeprecationWarning 2020-01-26 11:20:39 -08:00
test.py Nickometer: Use non-euclidian division as was originally intended. 2019-08-26 22:24:14 +02:00

README.rst

Documentation for the Nickometer plugin for Supybot

Purpose

A port of Infobot's nickometer command from Perl. This plugin provides one command (called nickometer) which will tell you how 'lame' an IRC nick is. It's an elitist hacker thing, but quite fun.

Usage

Will tell you how lame a nick is by the command 'nickometer [nick]'.

Commands

nickometer [<nick>]

Tells you how lame said nick is. If <nick> is not given, uses the nick of the person giving the command.

Configuration

supybot.plugins.Nickometer.public

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

Determines whether this plugin is publicly visible.