From 15a030ec9f5d9016c287cf3964894683121e59fd Mon Sep 17 00:00:00 2001
From: sfan5 <sfan5@live.de>
Date: Tue, 5 Nov 2019 19:24:51 +0100
Subject: Improve documentation around banning (#9088)

* Fix ban chatcommand description
* Correct ban API documentation
---
 builtin/game/chat.lua | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'builtin')

diff --git a/builtin/game/chat.lua b/builtin/game/chat.lua
index 424cbfe3f..37d12c458 100644
--- a/builtin/game/chat.lua
+++ b/builtin/game/chat.lua
@@ -909,8 +909,8 @@ core.register_chatcommand("shutdown", {
 })
 
 core.register_chatcommand("ban", {
-	params = "[<name> | <IP_address>]",
-	description = "Ban player or show ban list",
+	params = "[<name>]",
+	description = "Ban the IP of a player or show the ban list",
 	privs = {ban=true},
 	func = function(name, param)
 		if param == "" then
@@ -922,7 +922,7 @@ core.register_chatcommand("ban", {
 			end
 		end
 		if not core.get_player_by_name(param) then
-			return false, "No such player."
+			return false, "Player is not online."
 		end
 		if not core.ban_player(param) then
 			return false, "Failed to ban player."
@@ -935,7 +935,7 @@ core.register_chatcommand("ban", {
 
 core.register_chatcommand("unban", {
 	params = "<name> | <IP_address>",
-	description = "Remove player ban",
+	description = "Remove IP ban belonging to a player/IP",
 	privs = {ban=true},
 	func = function(name, param)
 		if not core.unban_player_or_ip(param) then
-- 
cgit v1.2.3