Clarify owner-only text command invocation

freya022 · Oct 29, 2024 · 0f93e06 · 0f93e06
1 parent cd7f046
commit 0f93e06
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/main/kotlin/io/github/freya022/botcommands/api/commands/text/annotations/RequireOwner.kt b/src/main/kotlin/io/github/freya022/botcommands/api/commands/text/annotations/RequireOwner.kt
@@ -1,9 +1,14 @@
 package io.github.freya022.botcommands.api.commands.text.annotations
 
 import io.github.freya022.botcommands.api.commands.text.builder.TextCommandBuilder
+import io.github.freya022.botcommands.api.core.BotOwners
 
 /**
- * Marks this text command as only usable by the bot owners.
+ * Marks this text command as only usable by the [bot owners][BotOwners].
+ *
+ * Owner-only commands are hidden in the built-in help content,
+ * but will still be responded to if a user tries to use it,
+ * though they will be rejected.
  *
  * **Note:** This applies to the command itself, not only this variation,
  * in other words, this applies to all commands with the same path.

diff --git a/...ain/kotlin/io/github/freya022/botcommands/api/commands/text/builder/TextCommandBuilder.kt b/...ain/kotlin/io/github/freya022/botcommands/api/commands/text/builder/TextCommandBuilder.kt
@@ -41,7 +41,11 @@ interface TextCommandBuilder : CommandBuilder {
     var description: String?
 
     /**
-     * Marks this text command as only usable by the bot owners.
+     * Marks this text command as only usable by the [bot owners][BotOwners].
+     *
+     * Owner-only commands are hidden in the built-in help content,
+     * but will still be responded to if a user tries to use it,
+     * though they will be rejected.
      *
      * @see RequireOwner
      */