Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-26 04:32:51 +01:00
Code Issues Projects Releases Wiki Activity
833af36b08
Limnoria/plugins/Note
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 Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py all plugins: Use msg.channel instead of msg.args[0] + give network name to self.registryValue. 2019-08-24 23:35:01 +02:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py Change the modeline to use softtabstop instead of tabstop. 2006-02-11 15:52:51 +00:00

README.rst

Documentation for the Note plugin for Supybot

Purpose

A complete messaging system that allows users to leave 'notes' for other users that can be retrieved later.

Usage

Allows you to send notes to other users.

Commands

list [--{old,sent}] [--{from,to} <user>]

Retrieves the ids of all your unread notes. If --old is given, list read notes. If --sent is given, list notes that you have sent. If --from is specified, only lists notes sent to you from <user>. If --to is specified, only lists notes sent by you to <user>.

next takes no arguments

Retrieves your next unread note, if any.

note <id>

Retrieves a single note by its unique note id. Use the 'note list' command to see what unread notes you have.

reply <id> <text>

Sends a note in reply to <id>.

search [--{regexp} <value>] [--sent] [<glob>]

Searches your received notes for ones matching <glob>. If --regexp is given, its associated value is taken as a regexp and matched against the notes. If --sent is specified, only search sent notes.

send <recipient>,[<recipient>,[...]] <text>

Sends a new note to the user specified. Multiple recipients may be specified by separating their names by commas.

unsend <id>

Unsends the note with the id given. You must be the author of the note, and it must be unread.

Configuration

supybot.plugins.Note.public

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

Determines whether this plugin is publicly visible.