mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01: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

2.0 KiB

Raw Blame History

Documentation for the String plugin for Supybot

Purpose

Provides various commands to manipulate characters and strings.

Usage

Provides useful commands for manipulating characters and strings.

Commands

chr <number>: Returns the unicode character associated with codepoint <number>
decode <encoding> <text>: Returns an un-encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: <http://docs.python.org/library/codecs.html#standard-encodings>.
encode <encoding> <text>: Returns an encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: <http://docs.python.org/library/codecs.html#standard-encodings>.
len <text>: Returns the length of <text>.
levenshtein <string1> <string2>: Returns the levenshtein distance (also known as the "edit distance" between <string1> and <string2>)
md5 <text>: Returns the md5 hash of a given string.
ord <letter>: Returns the unicode codepoint of <letter>.
re <regexp> <text>: If <regexp> is of the form m/regexp/flags, returns the portion of <text> that matches the regexp. If <regexp> is of the form s/regexp/replacement/flags, returns the result of applying such a regexp to <text>.
sha <text>: Returns the SHA1 hash of a given string.
soundex <string> [<length>]: Returns the Soundex hash to a given length. The length defaults to 4, since that's the standard length for a soundex hash. For unlimited length, use 0. Maximum length 1024.
unicodename <character>: Returns the name of the given unicode <character>.
unicodesearch <name>: Searches for a unicode character from its <name>.
xor <password> <text>: Returns <text> XOR-encrypted with <password>.

Configuration

supybot.plugins.String.public

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

Determines whether this plugin is publicly visible.

2.0 KiB Raw Blame History