Limnoria/plugins/Math/README.rst

.. _plugin-Math:

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-Math:

Commands
--------
.. _command-Math-base:

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

.. _command-Math-calc:

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**10**10**10'. One consequence is that large values such as '10**24' might not be exact.

.. _command-Math-convert:

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.

.. _command-Math-icalc:

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.

.. _command-Math-rpn:

rpn <rpn math expression>
  Returns the value of an RPN expression.

.. _command-Math-units:

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.
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:29:49 +02:00			`.. _plugin-Math:`

			`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.`

supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _commands-Math:`

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:29:49 +02:00			`Commands`
			`--------`
supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _command-Math-base:`

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:29:49 +02:00			`base <fromBase> [<toBase>] <number>`
			`Converts <number> from base <fromBase> to base <toBase>. If <toBase> is left out, it converts to decimal.`

supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _command-Math-calc:`

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:29:49 +02:00			`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 '10101010'. One consequence is that large values such as '1024' might not be exact.`

supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _command-Math-convert:`

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:29:49 +02:00			`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.`

supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _command-Math-icalc:`

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:29:49 +02:00			`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.`

supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _command-Math-rpn:`

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:29:49 +02:00			`rpn <rpn math expression>`
			`Returns the value of an RPN expression.`

supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. 2021-04-05 22:56:40 +02:00			`.. _command-Math-units:`

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:29:49 +02:00			`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.`