mirror of https://github.com/Mikaela/Limnoria.git synced 2024-10-01 17:16:31 +02: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.2 KiB

Raw Blame History

Documentation for the Time plugin for Supybot

Purpose

A plugin for time-related functions.

Usage

This plugin allows you to use different time-related functions.

Commands

at [<time string>]: Returns the number of seconds since epoch <time string> is. <time string> can be any number of natural formats; just try something and see if it will work. If the <time string> is not given, defaults to now.
ctime [<seconds since epoch>]: Returns the ctime for <seconds since epoch>, or the current ctime if no <seconds since epoch> is given.
ddate [<year> <month> <day>]: Returns a the Discordian date today, or an optional different date.
elapsed <seconds>: Returns a pretty string that is the amount of time represented by <seconds>.
seconds [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s]: Returns the number of seconds in the number of <years>, <weeks>, <days>, <hours>, <minutes>, and <seconds> given. An example usage is "seconds 2h 30m", which would return 9000, which is '3600*2 + 30*60'. Useful for scheduling events at a given number of seconds in the future.
time [<channel>] [<format>] [<seconds since epoch>]: Returns the current time in <format> format, or, if <format> is not given, uses the configurable format for the current channel. If no <seconds since epoch> time is given, the current time is used. If <channel> is given without <format>, uses the format for <channel>.
tztime <region>/<city>: Takes a city and its region, and returns its local time. This command uses the IANA Time Zone Database.
until <time string>: Returns the number of seconds until <time string>.

Configuration

supybot.plugins.Time.format

This config variable defaults to "%Y-%m-%dT%H:%M:%S%z", is network-specific, and is channel-specific.

Determines the format string for timestamps. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, the timestamp will not be shown.

supybot.plugins.Time.public

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

Determines whether this plugin is publicly visible.

2.2 KiB Raw Blame History