♻️ refactor(command): clarify non-player command sender requirement description

twisti-dev · twisti-dev · commit 0e316259efba · 2026-05-27T12:29:18.000+02:00
- update parameter description for allowIfNonPlayer to specify it bypasses player-only requirement
diff --git a/surf-api-paper/surf-api-paper/src/main/kotlin/dev/slne/surf/api/paper/command/requirement/SuspendCommandRequirements.kt b/surf-api-paper/surf-api-paper/src/main/kotlin/dev/slne/surf/api/paper/command/requirement/SuspendCommandRequirements.kt
@@ -26,7 +26,7 @@ import org.bukkit.entity.Player
  * execution should also be checked explicitly inside the command executor.
  *
  * @param scope the coroutine scope provider used to refresh the requirement
- * @param allowIfNonPlayer whether non-player command senders should be allowed
+ * @param allowIfNonPlayer whether non-player command senders should bypass this player-only requirement
  * @param requirement the suspendable predicate used to refresh the cached requirement
  * result for a player
  */

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import org.bukkit.entity.Player`
`26`	`26`	`* execution should also be checked explicitly inside the command executor.`
`27`	`27`	`*`
`28`	`28`	`* @param scope the coroutine scope provider used to refresh the requirement`
`29`		`- * @param allowIfNonPlayer whether non-player command senders should be allowed`
	`29`	`+ * @param allowIfNonPlayer whether non-player command senders should bypass this player-only requirement`
`30`	`30`	`* @param requirement the suspendable predicate used to refresh the cached requirement`
`31`	`31`	`* result for a player`
`32`	`32`	`*/`