From ff46ca546d976c3f0df2be89679ca351e6763c96 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sat, 30 May 2020 17:19:54 +0100 Subject: [PATCH 01/10] add class docstring to downloader idk what to say rly um hi all nice to be back after about 6 months pls no hate my PRs apoligies if i get in the way if you read this far then you deserve an achievement um i dunno what err how about the achievement of unboredness --- redbot/cogs/downloader/downloader.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/redbot/cogs/downloader/downloader.py b/redbot/cogs/downloader/downloader.py index 9c5ae61c0..68832d5f4 100644 --- a/redbot/cogs/downloader/downloader.py +++ b/redbot/cogs/downloader/downloader.py @@ -36,6 +36,16 @@ DEPRECATION_NOTICE = _( @cog_i18n(_) class Downloader(commands.Cog): + """Install community cogs from Cog Creators. + + Community cogs, also called third party cogs, are not included + in the default Red install. Cogs come in repositories. Repos are + groups of cogs by one creator you can install. + + You always need to add a repository using the `[p]repo` command + before you can install cogs from the repo. + """ + def __init__(self, bot: Red): super().__init__() self.bot = bot From c9cfa92b044e935f8a923394ff786e8a743b68f9 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sat, 30 May 2020 19:33:32 +0100 Subject: [PATCH 02/10] add class docstring to reports --- redbot/cogs/reports/reports.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/redbot/cogs/reports/reports.py b/redbot/cogs/reports/reports.py index ea010b04a..b4973485e 100644 --- a/redbot/cogs/reports/reports.py +++ b/redbot/cogs/reports/reports.py @@ -23,7 +23,13 @@ log = logging.getLogger("red.reports") @cog_i18n(_) class Reports(commands.Cog): + """Create user reports that server staff can respond to. + Users can open reports using `[p]report`. These are then + sent to a channel in the server, where staff members can + respond. + """ + default_guild_settings = {"output_channel": None, "active": False, "next_ticket": 1} default_report = {"report": {}} From 873c7be99ead9ba1e3379968f098957c4c02c57a Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sat, 30 May 2020 19:34:01 +0100 Subject: [PATCH 03/10] add class docstring to streams --- redbot/cogs/streams/streams.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/redbot/cogs/streams/streams.py b/redbot/cogs/streams/streams.py index 4029dc4b2..e47e16407 100644 --- a/redbot/cogs/streams/streams.py +++ b/redbot/cogs/streams/streams.py @@ -38,7 +38,15 @@ log = logging.getLogger("red.core.cogs.Streams") @cog_i18n(_) class Streams(commands.Cog): + """Various commands realting to streaming platforms. + You can check if a Twitch, YouTube, Picarto or Mixer stream is + currently live. Alerts can also be configured to post in a + channel when a streamer goes live. + + Twitch and YouTube need API tokens to work. + """ + global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []} guild_defaults = { From 6a00c0ee7ec010932c8aefd2f87aec12e264d8a8 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sat, 30 May 2020 19:42:33 +0100 Subject: [PATCH 04/10] black formatting oops lets not forget what tox checks for --- redbot/cogs/reports/reports.py | 2 +- redbot/cogs/streams/streams.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/redbot/cogs/reports/reports.py b/redbot/cogs/reports/reports.py index b4973485e..b88ff33e4 100644 --- a/redbot/cogs/reports/reports.py +++ b/redbot/cogs/reports/reports.py @@ -29,7 +29,7 @@ class Reports(commands.Cog): sent to a channel in the server, where staff members can respond. """ - + default_guild_settings = {"output_channel": None, "active": False, "next_ticket": 1} default_report = {"report": {}} diff --git a/redbot/cogs/streams/streams.py b/redbot/cogs/streams/streams.py index e47e16407..8b8693be3 100644 --- a/redbot/cogs/streams/streams.py +++ b/redbot/cogs/streams/streams.py @@ -46,7 +46,7 @@ class Streams(commands.Cog): Twitch and YouTube need API tokens to work. """ - + global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []} guild_defaults = { From 219586d55d56ebb17cc2eb0883000ade134e4b00 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sat, 30 May 2020 19:57:34 +0100 Subject: [PATCH 05/10] wording changes --- redbot/cogs/downloader/downloader.py | 13 +++++++------ redbot/cogs/reports/reports.py | 6 +++--- redbot/cogs/streams/streams.py | 2 +- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/redbot/cogs/downloader/downloader.py b/redbot/cogs/downloader/downloader.py index 68832d5f4..9f276d0ce 100644 --- a/redbot/cogs/downloader/downloader.py +++ b/redbot/cogs/downloader/downloader.py @@ -36,14 +36,15 @@ DEPRECATION_NOTICE = _( @cog_i18n(_) class Downloader(commands.Cog): - """Install community cogs from Cog Creators. + """Install community cogs made by Cog Creators. Community cogs, also called third party cogs, are not included - in the default Red install. Cogs come in repositories. Repos are - groups of cogs by one creator you can install. - - You always need to add a repository using the `[p]repo` command - before you can install cogs from the repo. + in the default Red install. + + Community cogs always come in repositories. Repos are a + group of cogs by one creator you can install. You always need + to add the creater's repository using the `[p]repo` command + before you can install cogs from the creator. """ def __init__(self, bot: Red): diff --git a/redbot/cogs/reports/reports.py b/redbot/cogs/reports/reports.py index b88ff33e4..8ced825f1 100644 --- a/redbot/cogs/reports/reports.py +++ b/redbot/cogs/reports/reports.py @@ -25,9 +25,9 @@ log = logging.getLogger("red.reports") class Reports(commands.Cog): """Create user reports that server staff can respond to. - Users can open reports using `[p]report`. These are then - sent to a channel in the server, where staff members can - respond. + Users can open reports using `[p]report`. These are then sent + to a channel in the server for staff, and the report creator + gets a DM. Both can be used to communicate. """ default_guild_settings = {"output_channel": None, "active": False, "next_ticket": 1} diff --git a/redbot/cogs/streams/streams.py b/redbot/cogs/streams/streams.py index 8b8693be3..7b8562777 100644 --- a/redbot/cogs/streams/streams.py +++ b/redbot/cogs/streams/streams.py @@ -44,7 +44,7 @@ class Streams(commands.Cog): currently live. Alerts can also be configured to post in a channel when a streamer goes live. - Twitch and YouTube need API tokens to work. + Twitch and YouTube need API tokens. """ global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []} From e6c46bf4dab3b7bb197950d0a754cc14111e3016 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sun, 31 May 2020 09:21:34 +0100 Subject: [PATCH 06/10] add cog board link --- redbot/cogs/downloader/downloader.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/redbot/cogs/downloader/downloader.py b/redbot/cogs/downloader/downloader.py index 9f276d0ce..909ecbfcf 100644 --- a/redbot/cogs/downloader/downloader.py +++ b/redbot/cogs/downloader/downloader.py @@ -45,6 +45,8 @@ class Downloader(commands.Cog): group of cogs by one creator you can install. You always need to add the creater's repository using the `[p]repo` command before you can install cogs from the creator. + + A list of approved repos can be found on the [Cog Board](https://cogboard.red/t/approved-repositories/210). """ def __init__(self, bot: Red): From 049f23071c46a3107048e4688153180751136932 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sun, 31 May 2020 10:18:58 +0100 Subject: [PATCH 07/10] hmm actually no (undo) --- redbot/cogs/downloader/downloader.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/redbot/cogs/downloader/downloader.py b/redbot/cogs/downloader/downloader.py index 909ecbfcf..9f276d0ce 100644 --- a/redbot/cogs/downloader/downloader.py +++ b/redbot/cogs/downloader/downloader.py @@ -45,8 +45,6 @@ class Downloader(commands.Cog): group of cogs by one creator you can install. You always need to add the creater's repository using the `[p]repo` command before you can install cogs from the creator. - - A list of approved repos can be found on the [Cog Board](https://cogboard.red/t/approved-repositories/210). """ def __init__(self, bot: Red): From 6b086e3eb28ee7d08e596d1a47e35229bd117765 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sun, 31 May 2020 11:16:39 +0100 Subject: [PATCH 08/10] wait grammar exists? who knew... --- redbot/cogs/streams/streams.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/redbot/cogs/streams/streams.py b/redbot/cogs/streams/streams.py index 7b8562777..726443209 100644 --- a/redbot/cogs/streams/streams.py +++ b/redbot/cogs/streams/streams.py @@ -38,13 +38,14 @@ log = logging.getLogger("red.core.cogs.Streams") @cog_i18n(_) class Streams(commands.Cog): - """Various commands realting to streaming platforms. + """Various commands relating to streaming platforms. You can check if a Twitch, YouTube, Picarto or Mixer stream is - currently live. Alerts can also be configured to post in a - channel when a streamer goes live. + currently live. Stream alerts can also be configured to + automatically post in a channel when a streamer goes live. - Twitch and YouTube need API tokens. + Twitch and YouTube require access to their API, so you need to + set API tokens. """ global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []} From 35e83855a8550adb166efc243e3953b38bc4c213 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Sun, 31 May 2020 13:15:38 +0100 Subject: [PATCH 09/10] remove admin only commands --- redbot/cogs/streams/streams.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/redbot/cogs/streams/streams.py b/redbot/cogs/streams/streams.py index 726443209..55840ed50 100644 --- a/redbot/cogs/streams/streams.py +++ b/redbot/cogs/streams/streams.py @@ -41,11 +41,7 @@ class Streams(commands.Cog): """Various commands relating to streaming platforms. You can check if a Twitch, YouTube, Picarto or Mixer stream is - currently live. Stream alerts can also be configured to - automatically post in a channel when a streamer goes live. - - Twitch and YouTube require access to their API, so you need to - set API tokens. + currently live. """ global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []} From 332bcae24f213034fe6c068207d0496fba3e4697 Mon Sep 17 00:00:00 2001 From: Vexed01 <51716387+Vexed01@users.noreply.github.com> Date: Fri, 5 Jun 2020 19:47:45 +0100 Subject: [PATCH 10/10] Review * Remove always - and consequently reorganise the words * Add "one or more" * Fix spelling of creator - changed from creater --- redbot/cogs/downloader/downloader.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/redbot/cogs/downloader/downloader.py b/redbot/cogs/downloader/downloader.py index 9f276d0ce..df8603d71 100644 --- a/redbot/cogs/downloader/downloader.py +++ b/redbot/cogs/downloader/downloader.py @@ -41,10 +41,10 @@ class Downloader(commands.Cog): Community cogs, also called third party cogs, are not included in the default Red install. - Community cogs always come in repositories. Repos are a - group of cogs by one creator you can install. You always need - to add the creater's repository using the `[p]repo` command - before you can install cogs from the creator. + Community cogs come in repositories. Repos are a group of cogs + you can install. You always need to add the creator's repository + using the `[p]repo` command before you can install one or more + cogs from the creator. """ def __init__(self, bot: Red):