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/Math
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
..
local Math: sync convertcore unit data with ConvertAll 0.7.2 2017-09-29 16:02:36 -07:00
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02: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 core/Math: Move the math evaluator to src/utils/. 2020-01-26 20:42:55 +01:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py Math: Fix test on Python 3.10 (nightly) 2020-09-19 10:38:07 +02:00

README.rst

Documentation for the Math plugin for Supybot

Purpose

This plugin provides a calculator, converter, a list of units and other useful math functions.

Usage

Provides commands to work with math, such as a calculator and a unit converter.

Commands

base <fromBase> [<toBase>] <number>

Converts <number> from base <fromBase> to base <toBase>. If <toBase> is left out, it converts to decimal.

calc <math expression>

Returns the value of the evaluated <math expression>. The syntax is Python syntax; the type of arithmetic is floating point. Floating point arithmetic is used in order to prevent a user from being able to crash to the bot with something like '10*101010'. One consequence is that large values such as '10*24' might not be exact.

convert [<number>] <unit> to <other unit>

Converts from <unit> to <other unit>. If number isn't given, it defaults to 1. For unit information, see 'units' command.

icalc <math expression>

This is the same as the calc command except that it allows integer math, and can thus cause the bot to suck up CPU. Hence it requires the 'trusted' capability to use.

rpn <rpn math expression>

Returns the value of an RPN expression.

units [<type>]

With no arguments, returns a list of measurement types, which can be passed as arguments. When called with a type as an argument, returns the units of that type.

Configuration

supybot.plugins.Math.public

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

Determines whether this plugin is publicly visible.