mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
Add missing class docstrings in Downloader, Reports and Streams (#3892)
* 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 * add class docstring to reports * add class docstring to streams * black formatting oops lets not forget what tox checks for * wording changes * add cog board link * hmm actually no (undo) * wait grammar exists? who knew... * remove admin only commands * Review * Remove always - and consequently reorganise the words * Add "one or more" * Fix spelling of creator - changed from creater
This commit is contained in:
commit
fd8ff7d7cf
@ -36,6 +36,17 @@ DEPRECATION_NOTICE = _(
|
|||||||
|
|
||||||
@cog_i18n(_)
|
@cog_i18n(_)
|
||||||
class Downloader(commands.Cog):
|
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 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):
|
def __init__(self, bot: Red):
|
||||||
super().__init__()
|
super().__init__()
|
||||||
self.bot = bot
|
self.bot = bot
|
||||||
|
|||||||
@ -23,6 +23,12 @@ log = logging.getLogger("red.reports")
|
|||||||
|
|
||||||
@cog_i18n(_)
|
@cog_i18n(_)
|
||||||
class Reports(commands.Cog):
|
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}
|
default_guild_settings = {"output_channel": None, "active": False, "next_ticket": 1}
|
||||||
|
|
||||||
|
|||||||
@ -38,6 +38,11 @@ log = logging.getLogger("red.core.cogs.Streams")
|
|||||||
|
|
||||||
@cog_i18n(_)
|
@cog_i18n(_)
|
||||||
class Streams(commands.Cog):
|
class Streams(commands.Cog):
|
||||||
|
"""Various commands relating to streaming platforms.
|
||||||
|
|
||||||
|
You can check if a Twitch, YouTube, Picarto or Mixer stream is
|
||||||
|
currently live.
|
||||||
|
"""
|
||||||
|
|
||||||
global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []}
|
global_defaults = {"refresh_timer": 300, "tokens": {}, "streams": []}
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user