CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Audio] Adjust docstrings (#5895)

Browse Source
This commit is contained in:
aikaterna 2022-10-30 18:00:32 -07:00 committed by GitHub
parent 115083b18b
commit 236d30f335
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
redbot/cogs/audio/core/commands/llset.py
View File

@ -36,7 +36,7 @@ class LavalinkSetupCommands(MixinMeta, metaclass=CompositeMetaClass):
async def command_llsetup(self, ctx: commands.Context): async def command_llsetup(self, ctx: commands.Context):
"""`Dangerous commands` Manage Lavalink node configuration settings. """`Dangerous commands` Manage Lavalink node configuration settings.
This command block holds all commands to manage an external or managed Lavalink node. This command block holds all commands to manage an unmanaged (external) or managed Lavalink node.
You should not mess with any command in here unless you have a valid reason to, You should not mess with any command in here unless you have a valid reason to,
i.e. been told by someone in the Red-Discord Bot support server to do so. i.e. been told by someone in the Red-Discord Bot support server to do so.
@ -50,7 +50,7 @@ class LavalinkSetupCommands(MixinMeta, metaclass=CompositeMetaClass):
This command shouldn't need to be used most of the time, and is only useful if the host machine has conflicting Java versions. This command shouldn't need to be used most of the time, and is only useful if the host machine has conflicting Java versions.
If changing this make sure that the java you set is supported by Audio. If changing this make sure that the Java executable you set is supported by Audio.
The current supported version is Java 11. The current supported version is Java 11.
Enter nothing or "java" to reset it back to default. Enter nothing or "java" to reset it back to default.
@ -268,7 +268,7 @@ class LavalinkSetupCommands(MixinMeta, metaclass=CompositeMetaClass):
async def command_llsetup_secured(self, ctx: commands.Context): async def command_llsetup_secured(self, ctx: commands.Context):
"""Set the Lavalink node connection to secured. """Set the Lavalink node connection to secured.
This command sets the connection type to secured when connecting to an external Lavalink node. This toggle sets the connection type to secured or unsecured when connecting to an external Lavalink node.
""" """
state = await self.config.secured_ws() state = await self.config.secured_ws()
await self.config.secured_ws.set(not state) await self.config.secured_ws.set(not state)
@ -680,7 +680,7 @@ class LavalinkSetupCommands(MixinMeta, metaclass=CompositeMetaClass):
*, *,
milliseconds: int = DEFAULT_LAVALINK_YAML["yaml__lavalink__server__bufferDurationMs"], milliseconds: int = DEFAULT_LAVALINK_YAML["yaml__lavalink__server__bufferDurationMs"],
): ):
"""`Dangerous command` Set the managed Lavalink node NAS buffer size. """`Dangerous command` Set the managed Lavalink node JDA-NAS buffer size.
Only change this if you have been directly advised to, changing it can cause significant playback issues. Only change this if you have been directly advised to, changing it can cause significant playback issues.
""" """

26
redbot/cogs/audio/core/events/dpy.py
View File

@ -119,46 +119,46 @@ DANGEROUS_COMMANDS = {
), ),
"command_llsetup_config_source_http": _( "command_llsetup_config_source_http": _(
"This command toggles the support of direct url streams like Icecast or Shoutcast streams. " "This command toggles the support of direct url streams like Icecast or Shoutcast streams. "
"An example is <http://ice6.somafm.com/gsclassic-128-mp3>; " "An example is <http://ice1.somafm.com/gsclassic-128-mp3>; "
"Disabling this will make the bot unable to play any direct url steam content." "disabling this will make the bot unable to play any direct url steam content."
), ),
"command_llsetup_config_source_bandcamp": _( "command_llsetup_config_source_bandcamp": _(
"This command toggles the support of Bandcamp audio playback. " "This command toggles the support of Bandcamp audio playback. "
"An example is <http://deaddiskdrive.bandcamp.com/track/crystal-glass>; " "An example is <http://deaddiskdrive.bandcamp.com/track/crystal-glass>; "
"Disabling this will make the bot unable to play any Bandcamp content", "disabling this will make the bot unable to play any Bandcamp content",
), ),
"command_llsetup_config_source_local": _( "command_llsetup_config_source_local": _(
"This command toggles the support of local track audio playback. " "This command toggles the support of local track audio playback. "
"for example `/mnt/data/my_super_funky_track.mp3`; " "An example is `/mnt/data/my_super_funky_track.mp3`; "
"Disabling this will make the bot unable to play any local track content." "disabling this will make the bot unable to play any local track content."
), ),
"command_llsetup_config_source_soundcloud": _( "command_llsetup_config_source_soundcloud": _(
"This command toggles the support of Soundcloud playback. " "This command toggles the support of Soundcloud playback. "
"An example is <https://soundcloud.com/user-103858850/tilla>; " "An example is <https://soundcloud.com/user-103858850/tilla>; "
"Disabling this will make the bot unable to play any Soundcloud content." "disabling this will make the bot unable to play any Soundcloud content."
), ),
"command_llsetup_config_source_youtube": _( "command_llsetup_config_source_youtube": _(
"This command toggles the support of YouTube playback (Spotify depends on YouTube). " "This command toggles the support of YouTube playback (Spotify depends on YouTube). "
"Disabling this will make the bot unable to play any YouTube content, " "Disabling this will make the bot unable to play any YouTube content: "
"this includes Spotify." "this includes Spotify."
), ),
"command_llsetup_config_source_twitch": _( "command_llsetup_config_source_twitch": _(
"This command toggles the support of Twitch playback. " "This command toggles the support of Twitch playback. "
"An example of this is <https://twitch.tv/monstercat>; " "An example of this is <https://twitch.tv/monstercat>; "
"Disabling this will make the bot unable to play any Twitch content." "disabling this will make the bot unable to play any Twitch content."
), ),
"command_llsetup_config_source_vimeo": _( "command_llsetup_config_source_vimeo": _(
"This command toggles the support of Vimeo playback. " "This command toggles the support of Vimeo playback. "
"An example of this is <https://vimeo.com/157743578>; " "An example of this is <https://vimeo.com/157743578>; "
"Disabling this will make the bot unable to play any Vimeo content." "disabling this will make the bot unable to play any Vimeo content."
), ),
"command_llsetup_config_server_framebuffer": _( "command_llsetup_config_server_framebuffer": _(
"This setting controls the managed nodes framebuffer, " "This setting controls the managed node's framebuffer, "
"Do not change this unless instructed." "do not change this unless instructed."
), ),
"command_llsetup_config_server_buffer": _( "command_llsetup_config_server_buffer": _(
"This setting controls the managed nodes NAS buffer, " "This setting controls the managed node's JDA-NAS buffer, "
"Do not change this unless instructed." "do not change this unless instructed."
), ),
"command_llsetup_reset": _("This command will reset every setting changed by `[p]llset`."), "command_llsetup_reset": _("This command will reset every setting changed by `[p]llset`."),
} }