Skip to content

Commit

Permalink
Added detailed description to shadow-ban command
Browse files Browse the repository at this point in the history
  • Loading branch information
Ascurius committed Feb 25, 2022
1 parent a56fdb4 commit 8a29b9b
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions synadm/cli/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -562,8 +562,16 @@ def user_login_cmd(helper, user_id, expire_days, expire, expire_ts,
help="Unban the specified user"
)
@click.pass_obj
def user_shadow_ban(helper: cli.APIHelper, user_id, unban):
"""Shadow-ban or unban a user
def user_shadow_ban(helper, user_id, unban):
"""Shadow-ban or unban a user.
Useful for moderating malicious or egregiously abusive users.
A shadow-banned user will not receive any notification, but still will be
unable to contact anyone on the server. Use this as a tool of last resort since it
may lead to confusing or broken behaviour for the client.
Generally, it is more appropriate to ban or kick abusive users.
"""
user_ban = helper.api.user_shadow_ban(user_id, unban)
helper.output(user_ban)

0 comments on commit 8a29b9b

Please sign in to comment.