aboutsummaryrefslogtreecommitdiffstats
path: root/bot
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2021-08-10 14:23:35 +0100
committerGravatar Chris Lovering <[email protected]>2021-08-10 14:23:35 +0100
commit66d531583beef60d27bcb3afdd4e127531b7cb75 (patch)
tree0f229328fe9b311c2ff838482ac69bd5feb14dbf /bot
parentSort the members before calculating a love score (diff)
Update love calculator docstring to reflect new behaviour
Since we update how the command behaves, by not allow arbitrary stings, and being symmetrical, we should reflect this in the docstring.
Diffstat (limited to 'bot')
-rw-r--r--bot/exts/valentines/lovecalculator.py14
1 files changed, 6 insertions, 8 deletions
diff --git a/bot/exts/valentines/lovecalculator.py b/bot/exts/valentines/lovecalculator.py
index d06d883d..d80f2adf 100644
--- a/bot/exts/valentines/lovecalculator.py
+++ b/bot/exts/valentines/lovecalculator.py
@@ -31,20 +31,18 @@ class LoveCalculator(Cog):
"""
Tells you how much the two love each other.
- This command accepts users or arbitrary strings as arguments.
- Users are converted from:
+ This command requires at least one member as input, if two are given love will be calculated between
+ those two users, if only one is given, the second member is asusmed to be the invoker.
+ Members are converted from:
- User ID
- Mention
- name#discrim
- name
- nickname
- Any two arguments will always yield the same result, though the order of arguments matters:
- Running .love joseph erlang will always yield the same result.
- Running .love erlang joseph won't yield the same result as .love joseph erlang
-
- If you want to use multiple words for one argument, you must include quotes.
- .love "Zes Vappa" "morning coffee"
+ Any two arguments will always yield the same result, regardless of the order of arguments:
+ Running .love @joe#6000 @chrisjl#2655 will always yield the same result.
+ Running .love @chrisjl#2655 @joe#6000 will yield the same result as before.
"""
if whom is None:
whom = ctx.author