Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

add some comments about all the command_spec spec types

Browse source
This commit is contained in:
jesopo 2020-01-24 16:50:25 +00:00
parent e16831cc83
commit 241382fe66
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/core_modules/command_spec.py
View file

@ -15,6 +15,19 @@ from src import EventManager, ModuleManager, utils
# this means, in practice, that "!r~channel" is a: # this means, in practice, that "!r~channel" is a:
# - "revelant" channel (current if in channel, explicit arg otherwise) # - "revelant" channel (current if in channel, explicit arg otherwise)
# - will be used to check if a user has permissions # - will be used to check if a user has permissions
#
# spec types:
# - "time" - +1w2d3h4m5s format time
# - "rchannel" - relevant channel. current channel if we're in channel,
# otherwise an explicit channel name argument
# - "channel" - an argument of a channel name
# - "cuser" - a nickname but only if they are in the current channel
# - "ruser" - revlevant user. either current user if no arguments, otherwise
# take nickname for user from given args
# - "user" - an argument of a user's nickname
# - "ouser" - an argument of a potentially offline user's nickname
# - "word" - one word from arguments
# - "..." - collect all remaining args in to a string
class Module(ModuleManager.BaseModule): class Module(ModuleManager.BaseModule):
def _spec_chunk(self, server, channel, user, spec_types, args): def _spec_chunk(self, server, channel, user, spec_types, args):