Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing class docstrings in Downloader, Reports and Streams #3892

Merged
merged 10 commits into from
Jun 11, 2020
Merged
11 changes: 11 additions & 0 deletions redbot/cogs/downloader/downloader.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@

@cog_i18n(_)
class Downloader(commands.Cog):
"""Install community cogs made by Cog Creators.

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
Vexed01 marked this conversation as resolved.
Show resolved Hide resolved
to add the creater's repository using the `[p]repo` command
Vexed01 marked this conversation as resolved.
Show resolved Hide resolved
before you can install cogs from the creator.
"""

def __init__(self, bot: Red):
super().__init__()
self.bot = bot
Expand Down
6 changes: 6 additions & 0 deletions redbot/cogs/reports/reports.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@

@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 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}

Expand Down
9 changes: 9 additions & 0 deletions redbot/cogs/streams/streams.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@

@cog_i18n(_)
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
Vexed01 marked this conversation as resolved.
Show resolved Hide resolved
set API tokens.
"""

global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []}

Expand Down