clean docstrings for commands, resolves #1
This commit is contained in:
213
cogs/misc.py
213
cogs/misc.py
@@ -109,11 +109,6 @@ class Misc(commands.Cog):
|
||||
async def stats(self, ctx) -> None:
|
||||
"""
|
||||
Get Stats
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
stats_embed: Optional[discord.Embed] = await self.util.get_stats_embed()
|
||||
@@ -129,11 +124,6 @@ class Misc(commands.Cog):
|
||||
async def listcoffees(self, ctx) -> None:
|
||||
"""
|
||||
List Available Coffees
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
coffees: str = ""
|
||||
try:
|
||||
@@ -151,11 +141,6 @@ class Misc(commands.Cog):
|
||||
async def listshoves(self, ctx) -> None:
|
||||
"""
|
||||
List Available Fates for shove command
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
fates: str = ""
|
||||
try:
|
||||
@@ -173,11 +158,6 @@ class Misc(commands.Cog):
|
||||
async def xmas(self, ctx) -> None:
|
||||
"""
|
||||
Countdown til xmas!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
emojis: dict = {
|
||||
@@ -218,11 +198,6 @@ class Misc(commands.Cog):
|
||||
async def randfact(self, ctx) -> None:
|
||||
"""
|
||||
Get a random (useless) fact!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
with ctx.channel.typing():
|
||||
@@ -238,12 +213,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Insult Someone (or yourself)
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id)
|
||||
@@ -279,13 +248,6 @@ class Misc(commands.Cog):
|
||||
language: Optional[str] = 'en') -> None:
|
||||
"""
|
||||
Compliment someone (or yourself)
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
language (Optional[str]) (default: 'en')
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
@@ -320,12 +282,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Get a whisky for yourself or a friend!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
if not recipient:
|
||||
@@ -364,12 +320,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Get a cocktail for yourself or a friend!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
if not recipient:
|
||||
@@ -412,12 +362,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Spray someone with water!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -452,12 +396,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Pass someone (or yourself) a barf bag!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -492,11 +430,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Tea!
|
||||
|
||||
Args:
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
tea: str = "a cup of tea"
|
||||
|
||||
@@ -548,12 +481,6 @@ class Misc(commands.Cog):
|
||||
message: str) -> None:
|
||||
"""
|
||||
Cowsay!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
message (str)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
cowfile: str = random.choice(self.COWS).replace(".cow", "")
|
||||
@@ -571,11 +498,6 @@ class Misc(commands.Cog):
|
||||
cowfile: Optional[str] = None) -> None:
|
||||
"""
|
||||
Fortune | Cowsay!
|
||||
|
||||
Args:
|
||||
cowfile (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
if not cowfile:
|
||||
@@ -597,11 +519,6 @@ class Misc(commands.Cog):
|
||||
async def listcows(self, ctx) -> None:
|
||||
"""
|
||||
List available .cow files (for cowsay)
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
cow_list: str = ""
|
||||
try:
|
||||
@@ -621,12 +538,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Cyanide!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -667,12 +578,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
School gravy! (It's deadly)
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -713,12 +618,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Cold water! Drink up.
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -758,12 +657,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Shove someone! (Or yourself)
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
chosen_fate: str = random.choice(self.FATES)
|
||||
|
||||
@@ -800,12 +693,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Coffee!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
|
||||
recipient_allergic: bool = False
|
||||
@@ -853,12 +740,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Cookies!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -898,12 +779,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Hashbrowns!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -938,12 +813,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Ritalini!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -980,12 +849,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Grilled Cheese!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -1020,12 +883,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Soup!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -1060,12 +917,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Muffins!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -1105,12 +956,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Bacon!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -1150,12 +995,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Hang someone!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -1196,12 +1035,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Touch someone!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id)
|
||||
if not guild:
|
||||
@@ -1249,11 +1082,6 @@ class Misc(commands.Cog):
|
||||
async def qajoke(self, ctx) -> None:
|
||||
"""
|
||||
Get a joke in Q/A Form!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
qajoke: Optional[tuple] = await self.util.get_qajoke()
|
||||
@@ -1273,11 +1101,6 @@ class Misc(commands.Cog):
|
||||
async def rjoke(self, ctx) -> None:
|
||||
"""
|
||||
Get a joke! (from r/jokes scrape)
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns;
|
||||
None
|
||||
"""
|
||||
try:
|
||||
rjoke: Optional[tuple] = await self.util.get_rjoke()
|
||||
@@ -1300,12 +1123,6 @@ class Misc(commands.Cog):
|
||||
recipient: Optional[str] = None) -> None:
|
||||
"""
|
||||
Joints!
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
recipient (Optional[str])
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
|
||||
else ctx.message.author.display_name
|
||||
@@ -1348,11 +1165,6 @@ class Misc(commands.Cog):
|
||||
async def isitfriday(self, ctx) -> None:
|
||||
"""
|
||||
IS IT FRIDAY!?
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
today: datetime.datetime = datetime.datetime.today()
|
||||
@@ -1369,11 +1181,6 @@ class Misc(commands.Cog):
|
||||
async def isitflyday(self, ctx) -> None:
|
||||
"""
|
||||
IS IT FLYDAY!?
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
today: datetime.datetime = datetime.datetime.today()
|
||||
@@ -1395,12 +1202,6 @@ class Misc(commands.Cog):
|
||||
term: str) -> None:
|
||||
"""
|
||||
Not sure what that term means? UD prolly knows.
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
term (str)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
with ctx.channel.typing():
|
||||
@@ -1421,12 +1222,6 @@ class Misc(commands.Cog):
|
||||
async def joint_context_menu(self, ctx, member: discord.Member) -> None:
|
||||
"""
|
||||
Joint Context Menu
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
member (discord.Member)
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
strain: Optional[tuple] = await self.util.get_strain()
|
||||
if not strain:
|
||||
@@ -1442,13 +1237,7 @@ class Misc(commands.Cog):
|
||||
@commands.user_command(name="Give Coffee")
|
||||
async def coffee_context_menu(self, ctx, member: discord.Member) -> None:
|
||||
"""
|
||||
Coffee Context Menu
|
||||
|
||||
Args:
|
||||
ctx (Any)
|
||||
member (discord.Member)
|
||||
Returns:
|
||||
None
|
||||
Coffee Context Menu
|
||||
"""
|
||||
recipient_allergic: bool = False
|
||||
if member.id in [898332028007751741]:
|
||||
|
||||
Reference in New Issue
Block a user