Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-06 02:59:22 +01:00
Code Issues Projects Releases Wiki Activity
f409111872
Limnoria/plugins/Hashes/README.rst

64 lines
1.2 KiB
ReStructuredText
Raw Normal View History

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-Hashes:
Documentation for the Hashes plugin for Supybot
===============================================
Purpose
-------
supybot-plugin-doc: Add missing newlines + regenerate all READMEs.
2021-12-04 02:50:28 +01:00
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
Provides various hash- and encryption-related commands.
Usage
-----
supybot-plugin-doc: Add missing newlines + regenerate all READMEs.
2021-12-04 02:50:28 +01:00
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
Provides hash or encryption related 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
.. _commands-Hashes:
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 missing newlines + regenerate all READMEs.
2021-12-04 02:50:28 +01:00
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-hashes-algorithms:
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
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
algorithms <takes no arguments>
Returns the list of available algorithms.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-hashes-md5:
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
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
md5 <text>
Returns the md5 hash of a given string.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-hashes-mkhash:
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
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
mkhash <algorithm> <text>
Returns TEXT after it has been hashed with ALGORITHM. See the 'algorithms' command in this plugin to return the algorithms available on this system.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-hashes-sha:
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
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
sha <text>
Returns the SHA1 hash of a given string.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-hashes-sha256:
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
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
sha256 <text>
Returns a SHA256 hash of the given string.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-hashes-sha512:
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
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
sha512 <text>
Returns a SHA512 hash of the given string.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _conf-Hashes:
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
Configuration
-------------
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _conf-supybot.plugins.Hashes.public:
all plugins: regenerate READMEs
2021-04-22 00:29:15 +02:00
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
supybot.plugins.Hashes.public
supybot-plugin-doc: Remove extra space + regenerate all READMEs.
2021-12-04 03:19:12 +01:00
This config variable defaults to "True", is not network-specific, and is not channel-specific.
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
Determines whether this plugin is publicly visible.
Reference in New Issue Copy Permalink