diff --git a/README.md b/README.md index 15d547c..de21567 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,25 @@ When you need statistics about your discord server * `%help (command)` - info about commands * `%info` - version and uptime -* `%scan`: full analysis -* `%freq`: frequency analysis -* `%compo`: composition analysis -* `%pres`: presence analysis -* `%emojis` : rank emotes by their usage +* `%scan` - full analysis +* `%freq` - frequency analysis +* `%compo` - composition analysis +* `%pres` - presence analysis +* `%emojis` - rank emotes by their usage * arguments: - * : top emojis, default is 20 - * all : list all common emojis in addition to this guild's - * members : show top member for each emote - * sort:usage/reaction : other sorting methods -* `%mentions`: rank mentions by their usage + * `` - top emojis, default is 20 + * `all` - list all common emojis in addition to this guild's + * `members` - show top member for each emote + * `sort:usage/reaction` - other sorting methods +* `%mentions` - rank mentions by their usage * arguments: - * : top mentions, default is 10 - * all : show role/channel/everyone/here mentions -* `%cancel` : cancel current analysis + * `` - top mentions, default is 10 + * `all` - show role/channel/everyone/here mentions +* `%mentioned` - rank specific user mentions by their usage + * arguments: + * `` - top mentions, default is 10 + * `all` - show role/channel/everyone/here mentions +* `%cancel` - cancel current analysis * Common arguments: * @member/me : filter for one or more member diff --git a/src/main.py b/src/main.py index 6210987..a20b688 100644 --- a/src/main.py +++ b/src/main.py @@ -31,10 +31,10 @@ bot.register_command( "(cancel|stop)", GuildLogs.cancel, "cancel: stop current analysis", - "```\n" + "%cancel : Stop current analysis\n" + "```", + "```\n" + "%cancel: Stop current analysis\n" + "```", ) bot.register_command( - "(mentioned)", + "mentioned", lambda *args: MentionedScanner().compute(*args), "mentioned: rank specific user mentions by their usage", MentionedScanner.help(), diff --git a/src/scanners/composition_scanner.py b/src/scanners/composition_scanner.py index 3e40c55..8de4b93 100644 --- a/src/scanners/composition_scanner.py +++ b/src/scanners/composition_scanner.py @@ -16,7 +16,7 @@ class CompositionScanner(Scanner): def help() -> str: return ( "```\n" - + "%compo : Show composition statistics\n" + + "%compo: Show composition statistics\n" + "arguments:\n" + COMMON_HELP_ARGS + "Example: %compo #mychannel1 @user\n" diff --git a/src/scanners/emotes_scanner.py b/src/scanners/emotes_scanner.py index bef6174..23c51ff 100644 --- a/src/scanners/emotes_scanner.py +++ b/src/scanners/emotes_scanner.py @@ -16,13 +16,13 @@ class EmotesScanner(Scanner): def help() -> str: return ( "```\n" - + "%emojis : Rank emojis by their usage\n" + + "%emojis: Rank emojis by their usage\n" + "arguments:\n" + COMMON_HELP_ARGS - + "* : top emojis, default is 20\n" - + "* all : list all common emojis in addition to this guild's\n" - + "* members : show top member for each emojis\n" - + "* sort:usage/reaction : other sorting methods\n" + + "* - top emojis, default is 20\n" + + "* all - list all common emojis in addition to this guild's\n" + + "* members - show top member for each emojis\n" + + "* sort:usage/reaction - other sorting methods\n" + "Example: %emojis 10 all #mychannel1 #mychannel2 @user\n" + "```" ) diff --git a/src/scanners/frequency_scanner.py b/src/scanners/frequency_scanner.py index a666f78..15a48bb 100644 --- a/src/scanners/frequency_scanner.py +++ b/src/scanners/frequency_scanner.py @@ -16,7 +16,7 @@ class FrequencyScanner(Scanner): def help() -> str: return ( "```\n" - + "%freq : Show frequency-related statistics\n" + + "%freq: Show frequency-related statistics\n" + "arguments:\n" + COMMON_HELP_ARGS + "Example: %freq #mychannel1 @user\n" diff --git a/src/scanners/full_scanner.py b/src/scanners/full_scanner.py index 4721fd2..8aac8ea 100644 --- a/src/scanners/full_scanner.py +++ b/src/scanners/full_scanner.py @@ -16,7 +16,7 @@ class FullScanner(Scanner): def help() -> str: return ( "```\n" - + "%scan : Show full statistics\n" + + "%scan: Show full statistics\n" + "arguments:\n" + COMMON_HELP_ARGS + "Example: %scan #mychannel1 @user\n" diff --git a/src/scanners/mentioned_scanner.py b/src/scanners/mentioned_scanner.py index 8c2f63a..8e4a1db 100644 --- a/src/scanners/mentioned_scanner.py +++ b/src/scanners/mentioned_scanner.py @@ -24,12 +24,12 @@ class MentionedScanner(Scanner): def help() -> str: return ( "```\n" - + "%mentioned : Rank specific user's mentions by their usage\n" + + "%mentioned: Rank specific user's mentions by their usage\n" + "arguments:\n" - + "* @member/me : (required) one or more member\n" + + "* @member/me - (required) one or more member\n" + "\n".join(COMMON_HELP_ARGS.split("\n")[1:]) - + "* : top mentions, default is 10\n" - + "* all: include bots mentions\n" + + "* - top mentions, default is 10\n" + + "* all - include bots mentions\n" + "Example: %mentioned 10 @user\n" + "```" ) diff --git a/src/scanners/mentions_scanner.py b/src/scanners/mentions_scanner.py index 8bb013d..7126213 100644 --- a/src/scanners/mentions_scanner.py +++ b/src/scanners/mentions_scanner.py @@ -24,11 +24,11 @@ class MentionsScanner(Scanner): def help() -> str: return ( "```\n" - + "%mentions : Rank mentions by their usage\n" + + "%mentions: Rank mentions by their usage\n" + "arguments:\n" + COMMON_HELP_ARGS - + "* : top mentions, default is 10\n" - + "* all : show role/channel/everyone/here mentions\n" + + "* - top mentions, default is 10\n" + + "* all - show role/channel/everyone/here mentions\n" + "Example: %mentions 10 #mychannel1 #mychannel2 @user\n" + "```" ) diff --git a/src/scanners/presence_scanner.py b/src/scanners/presence_scanner.py index 9d9dbcc..765b64b 100644 --- a/src/scanners/presence_scanner.py +++ b/src/scanners/presence_scanner.py @@ -15,7 +15,7 @@ class PresenceScanner(Scanner): def help() -> str: return ( "```\n" - + "%pres : Show presence statistics\n" + + "%pres: Show presence statistics\n" + "arguments:\n" + COMMON_HELP_ARGS + "Example: %pres #mychannel1 @user\n" diff --git a/src/utils/utils.py b/src/utils/utils.py index 8807fd6..9c84514 100644 --- a/src/utils/utils.py +++ b/src/utils/utils.py @@ -9,9 +9,9 @@ from datetime import datetime COMMON_HELP_ARGS = ( "" - + "* @member/me : filter for one or more member\n" - + "* #channel/here : filter for one or more channel\n" - + "* fast: only read cache\n" + + "* @member/me - filter for one or more member\n" + + "* #channel/here - filter for one or more channel\n" + + "* fast - only read cache\n" )