Skip to content

Commit

Permalink
supybot-plugin-doc: Remove extra space + regenerate all READMEs.
Browse files Browse the repository at this point in the history
  • Loading branch information
progval committed Dec 4, 2021
1 parent 2d22417 commit ed9dffd
Show file tree
Hide file tree
Showing 70 changed files with 316 additions and 316 deletions.
2 changes: 1 addition & 1 deletion plugins/Admin/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Configuration


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

Determines whether this plugin is publicly visible.

6 changes: 3 additions & 3 deletions plugins/Aka/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,15 @@ Configuration


supybot.plugins.Aka.maximumWordsInName
This config variable defaults to "5", is not network-specific, and is not channel-specific.
This config variable defaults to "5", is not network-specific, and is not channel-specific.

The maximum number of words allowed in a command name. Setting this to an high value may slow down your bot on long commands.

.. _conf-supybot.plugins.Aka.public:


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

Determines whether this plugin is publicly visible.

Expand All @@ -155,7 +155,7 @@ supybot.plugins.Aka.web


supybot.plugins.Aka.web.enable
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.

Determines whether the Akas will be browsable through the HTTP server.

4 changes: 2 additions & 2 deletions plugins/Alias/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,15 @@ supybot.plugins.Alias.escapedaliases


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

Determines whether this plugin is publicly visible.

.. _conf-supybot.plugins.Alias.validName:


supybot.plugins.Alias.validName
This config variable defaults to "^[^\\x00-\\x20]+$", is not network-specific, and is not channel-specific.
This config variable defaults to "^[^\\x00-\\x20]+$", is not network-specific, and is not channel-specific.

Regex which alias names must match in order to be valid

10 changes: 5 additions & 5 deletions plugins/Anonymous/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,39 +80,39 @@ Configuration


supybot.plugins.Anonymous.allowPrivateTarget
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.

Determines whether the bot will allow the "tell" command to be used. If true, the bot will allow the "tell" command to send private messages to other users.

.. _conf-supybot.plugins.Anonymous.public:


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

Determines whether this plugin is publicly visible.

.. _conf-supybot.plugins.Anonymous.requireCapability:


supybot.plugins.Anonymous.requireCapability
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.

Determines what capability (if any) the bot should require people trying to use this plugin to have.

.. _conf-supybot.plugins.Anonymous.requirePresenceInChannel:


supybot.plugins.Anonymous.requirePresenceInChannel
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to.

.. _conf-supybot.plugins.Anonymous.requireRegistration:


supybot.plugins.Anonymous.requireRegistration
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot should require people trying to use this plugin to be registered.

24 changes: 12 additions & 12 deletions plugins/AutoMode/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,95 +37,95 @@ Configuration


supybot.plugins.AutoMode.alternativeCapabilities
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot will check for 'alternative capabilities' (ie. autoop, autohalfop, autovoice) in addition to/instead of classic ones.

.. _conf-supybot.plugins.AutoMode.ban:


supybot.plugins.AutoMode.ban
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot will automatically ban people who join the channel and are on the banlist.

.. _conf-supybot.plugins.AutoMode.ban.period:


supybot.plugins.AutoMode.ban.period
This config variable defaults to "86400", is network-specific, and is channel-specific.
This config variable defaults to "86400", is network-specific, and is channel-specific.

Determines how many seconds the bot will automatically ban a person when banning.

.. _conf-supybot.plugins.AutoMode.delay:


supybot.plugins.AutoMode.delay
This config variable defaults to "0", is network-specific, and is channel-specific.
This config variable defaults to "0", is network-specific, and is channel-specific.

Determines how many seconds the bot will wait before applying a mode. Has no effect on bans.

.. _conf-supybot.plugins.AutoMode.enable:


supybot.plugins.AutoMode.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether this plugin is enabled.

.. _conf-supybot.plugins.AutoMode.extra:


supybot.plugins.AutoMode.extra
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.

Extra modes that will be applied to a user. Example syntax: user1+o-v user2+v user3-v

.. _conf-supybot.plugins.AutoMode.fallthrough:


supybot.plugins.AutoMode.fallthrough
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on.

.. _conf-supybot.plugins.AutoMode.halfop:


supybot.plugins.AutoMode.halfop
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether the bot will automatically halfop people with the <channel>,halfop capability when they join the channel.

.. _conf-supybot.plugins.AutoMode.op:


supybot.plugins.AutoMode.op
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether the bot will automatically op people with the <channel>,op capability when they join the channel.

.. _conf-supybot.plugins.AutoMode.owner:


supybot.plugins.AutoMode.owner
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.

Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability.

.. _conf-supybot.plugins.AutoMode.public:


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

Determines whether this plugin is publicly visible.

.. _conf-supybot.plugins.AutoMode.voice:


supybot.plugins.AutoMode.voice
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether the bot will automatically voice people with the <channel>,voice capability when they join the channel.

4 changes: 2 additions & 2 deletions plugins/Autocomplete/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Configuration


supybot.plugins.Autocomplete.enabled
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.

Whether the bot should reply to autocomplete requests from clients.

.. _conf-supybot.plugins.Autocomplete.public:


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

Determines whether this plugin is publicly visible.

20 changes: 10 additions & 10 deletions plugins/BadWords/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,79 +47,79 @@ Configuration


supybot.plugins.BadWords.kick
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether the bot will kick people with a warning when they use bad words.

.. _conf-supybot.plugins.BadWords.kick.message:


supybot.plugins.BadWords.kick.message
This config variable defaults to "You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.", is network-specific, and is channel-specific.
This config variable defaults to "You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.", is network-specific, and is channel-specific.

Determines the kick message used by the bot when kicking users for saying bad words.

.. _conf-supybot.plugins.BadWords.nastyChars:


supybot.plugins.BadWords.nastyChars
This config variable defaults to "!@#&", is not network-specific, and is not channel-specific.
This config variable defaults to "!@#&", is not network-specific, and is not channel-specific.

Determines what characters will replace bad words; a chunk of these characters matching the size of the replaced bad word will be used to replace the bad words you've configured.

.. _conf-supybot.plugins.BadWords.phrases:


supybot.plugins.BadWords.phrases
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.

Comma-separated groups of words that are considered to be 'bad'.

.. _conf-supybot.plugins.BadWords.public:


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

Determines whether this plugin is publicly visible.

.. _conf-supybot.plugins.BadWords.replaceMethod:


supybot.plugins.BadWords.replaceMethod
This config variable defaults to "nastyCharacters", is not network-specific, and is not channel-specific.
This config variable defaults to "nastyCharacters", is not network-specific, and is not channel-specific.

Determines the manner in which bad words will be replaced. 'nastyCharacters' (the default) will replace a bad word with the same number of 'nasty characters' (like those used in comic books; configurable by supybot.plugins.BadWords.nastyChars). 'simple' will replace a bad word with a simple strings (regardless of the length of the bad word); this string is configurable via supybot.plugins.BadWords.simpleReplacement. Valid strings: simple and nastyCharacters.

.. _conf-supybot.plugins.BadWords.requireWordBoundaries:


supybot.plugins.BadWords.requireWordBoundaries
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether the bot will require bad words to be independent words, or whether it will censor them within other words. For instance, if 'darn' is a bad word, then if this is true, 'darn' will be censored, but 'darnit' will not. You probably want this to be false. After changing this setting, the BadWords regexp needs to be regenerated by adding/removing a word to the list, or reloading the plugin.

.. _conf-supybot.plugins.BadWords.simpleReplacement:


supybot.plugins.BadWords.simpleReplacement
This config variable defaults to "[CENSORED]", is not network-specific, and is not channel-specific.
This config variable defaults to "[CENSORED]", is not network-specific, and is not channel-specific.

Determines what word will replace bad words if the replacement method is 'simple'.

.. _conf-supybot.plugins.BadWords.stripFormatting:


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

Determines whether the bot will strip formatting characters from messages before it checks them for bad words. If this is False, it will be relatively trivial to circumvent this plugin's filtering. If it's True, however, it will interact poorly with other plugins that do coloring or bolding of text.

.. _conf-supybot.plugins.BadWords.words:


supybot.plugins.BadWords.words
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.

Determines what words are considered to be 'bad' so the bot won't say them.

10 changes: 5 additions & 5 deletions plugins/Channel/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,39 +225,39 @@ Configuration


supybot.plugins.Channel.alwaysRejoin
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel.

.. _conf-supybot.plugins.Channel.nicksInPrivate:


supybot.plugins.Channel.nicksInPrivate
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the output of 'nicks' will be sent in private. This prevents mass-highlights of a channel's users, accidental or on purpose.

.. _conf-supybot.plugins.Channel.partMsg:


supybot.plugins.Channel.partMsg
This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific.
This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific.

Determines what part message should be used by default. If the part command is called without a part message, this will be used. If this value is empty, then no part message will be used (they are optional in the IRC protocol). The standard substitutions ($version, $nick, etc.) are all handled appropriately.

.. _conf-supybot.plugins.Channel.public:


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

Determines whether this plugin is publicly visible.

.. _conf-supybot.plugins.Channel.rejoinDelay:


supybot.plugins.Channel.rejoinDelay
This config variable defaults to "0", is network-specific, and is channel-specific.
This config variable defaults to "0", is network-specific, and is channel-specific.

Determines how many seconds the bot will wait before rejoining a channel if kicked and supybot.plugins.Channel.alwaysRejoin is on.

Loading

0 comments on commit ed9dffd

Please sign in to comment.