[Audio] Adjust docstrings (#5895)

This commit is contained in:
aikaterna
2022-10-30 18:00:32 -07:00
committed by GitHub
parent 115083b18b
commit 236d30f335
2 changed files with 17 additions and 17 deletions

View File

@@ -36,7 +36,7 @@ class LavalinkSetupCommands(MixinMeta, metaclass=CompositeMetaClass):
async def command_llsetup(self, ctx: commands.Context):
"""`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,
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.
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.
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):
"""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()
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"],
):
"""`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.
"""