From 1dc7d3859e071b3587e41098ceaff37971317c9a Mon Sep 17 00:00:00 2001 From: xedre Date: Fri, 5 Oct 2018 22:22:20 +0100 Subject: added docstring to repository --- bot/cogs/template.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'bot/cogs/template.py') diff --git a/bot/cogs/template.py b/bot/cogs/template.py index 89f12fe1..b3f4da21 100644 --- a/bot/cogs/template.py +++ b/bot/cogs/template.py @@ -12,6 +12,9 @@ class Template: @commands.command(name='repo', aliases=['repository', 'project'], brief='A link to the repository of this bot.') async def repository(self, ctx): + """ + A command to send the hacktoberbot github project + """ await ctx.send('https://github.com/discord-python/hacktoberbot') @commands.group(name='git', invoke_without_command=True) -- cgit v1.2.3 From 79dc1d87824b6ab1afc2832f4e40c981ac8f0e20 Mon Sep 17 00:00:00 2001 From: Leon Sandøy Date: Fri, 12 Oct 2018 00:27:22 +0200 Subject: improving the .help docstrings, and making the bot load cogs from the correct path. (#43) * Improving some docstrings and making it look in ./bot/cogs for cogs. * Removing pointless stuff from a docstring --- bot/__main__.py | 6 +++--- bot/cogs/halloweenify.py | 3 +++ bot/cogs/movie.py | 5 ++++- bot/cogs/template.py | 2 +- 4 files changed, 11 insertions(+), 5 deletions(-) (limited to 'bot/cogs/template.py') diff --git a/bot/__main__.py b/bot/__main__.py index 2c41d2d9..ccd69b0b 100644 --- a/bot/__main__.py +++ b/bot/__main__.py @@ -17,15 +17,15 @@ else: ghost_unicode = "\N{GHOST}" bot = commands.Bot(command_prefix=commands.when_mentioned_or(".", f"{ghost_unicode} ", ghost_unicode)) -log.info('Start loading extensions from ./cogs/') +log.info('Start loading extensions from ./bot/cogs/') if __name__ == '__main__': # Scan for files in the /cogs/ directory and make a list of the file names. - cogs = [file.stem for file in Path('cogs').glob('*.py')] + cogs = [file.stem for file in Path('bot', 'cogs').glob('*.py')] for extension in cogs: try: - bot.load_extension(f'cogs.{extension}') + bot.load_extension(f'bot.cogs.{extension}') log.info(f'Successfully loaded extension: {extension}') except Exception as e: log.error(f'Failed to load extension {extension}: {repr(e)} {format_exc()}') diff --git a/bot/cogs/halloweenify.py b/bot/cogs/halloweenify.py index ddd96bc6..3bd04b80 100644 --- a/bot/cogs/halloweenify.py +++ b/bot/cogs/halloweenify.py @@ -18,6 +18,9 @@ class Halloweenify: @commands.cooldown(1, 300, BucketType.user) @commands.command() async def halloweenify(self, ctx): + """ + Change your nickname into a much spookier one! + """ with open(Path('../bot/resources', 'halloweenify.json'), 'r') as f: data = load(f) diff --git a/bot/cogs/movie.py b/bot/cogs/movie.py index 82b9c682..925f813f 100644 --- a/bot/cogs/movie.py +++ b/bot/cogs/movie.py @@ -18,8 +18,11 @@ class Movie: def __init__(self, bot): self.bot = bot - @commands.command(name='movie', alias=['tmdb'], brief='Pick a scary movie') + @commands.command(name='movie', alias=['tmdb']) async def random_movie(self, ctx): + """ + Randomly select a scary movie and display information about it. + """ selection = await self.select_movie() movie_details = await self.format_metadata(selection) diff --git a/bot/cogs/template.py b/bot/cogs/template.py index b3f4da21..aa01432c 100644 --- a/bot/cogs/template.py +++ b/bot/cogs/template.py @@ -17,7 +17,7 @@ class Template: """ await ctx.send('https://github.com/discord-python/hacktoberbot') - @commands.group(name='git', invoke_without_command=True) + @commands.group(name='git', invoke_without_command=True, brief="A link to resources for learning Git") async def github(self, ctx): """ A command group with the name git. You can now create sub-commands such as git commit. -- cgit v1.2.3