aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2023-05-10 21:22:23 +0200
committerDaniel Schadt <kingdread@gmx.de>2023-05-10 21:22:23 +0200
commit56acb746a8eecd1d8180ebd34bf757647be48efd (patch)
tree28ab4c5760beb5107a0ed69a52f3d418f99bebe5
parent41e9ca178b1db3d89164ae7d56d749212d5de8d9 (diff)
downloadfietsboek-56acb746a8eecd1d8180ebd34bf757647be48efd.tar.gz
fietsboek-56acb746a8eecd1d8180ebd34bf757647be48efd.tar.bz2
fietsboek-56acb746a8eecd1d8180ebd34bf757647be48efd.zip
touch up fietsctl help strings
This makes them a bit more consistent with the command docstrings (even though they are not always complete sentences).
-rw-r--r--fietsboek/scripts/fietsctl.py38
1 files changed, 19 insertions, 19 deletions
diff --git a/fietsboek/scripts/fietsctl.py b/fietsboek/scripts/fietsctl.py
index 9bf8abe..39d9e8a 100644
--- a/fietsboek/scripts/fietsctl.py
+++ b/fietsboek/scripts/fietsctl.py
@@ -54,8 +54,8 @@ def cmd_user():
@cmd_user.command("add")
@config_option
-@click.option("--email", help="email address of the user", prompt=True)
-@click.option("--name", help="name of the user", prompt=True)
+@click.option("--email", help="Email address of the user.", prompt=True)
+@click.option("--name", help="Name of the user.", prompt=True)
@click.option(
"--password",
help="password of the user",
@@ -63,7 +63,7 @@ def cmd_user():
hide_input=True,
confirmation_prompt=True,
)
-@click.option("--admin", help="make the new user an admin", is_flag=True)
+@click.option("--admin", help="Make the new user an admin.", is_flag=True)
@click.pass_context
def cmd_user_add(
ctx: click.Context,
@@ -112,10 +112,10 @@ def cmd_user_add(
@cmd_user.command("del")
@config_option
-@click.option("--force", "-f", help="override the safety check", is_flag=True)
+@click.option("--force", "-f", help="Override the safety check.", is_flag=True)
@optgroup.group("User selection", cls=RequiredMutuallyExclusiveOptionGroup)
-@optgroup.option("--id", "-i", "id_", help="database ID of the user", type=int)
-@optgroup.option("--email", "-e", help="email of the user")
+@optgroup.option("--id", "-i", "id_", help="Database ID of the user.", type=int)
+@optgroup.option("--email", "-e", help="Email address of the user.")
@click.pass_context
def user_del(
ctx: click.Context,
@@ -179,10 +179,10 @@ def cmd_user_list(config: str):
@cmd_user.command("passwd")
@config_option
-@click.option("--password", help="password of the user")
+@click.option("--password", help="Password of the user.")
@optgroup.group("User selection", cls=RequiredMutuallyExclusiveOptionGroup)
-@optgroup.option("--id", "-i", "id_", help="database ID of the user", type=int)
-@optgroup.option("--email", "-e", help="email of the user")
+@optgroup.option("--id", "-i", "id_", help="Database ID of the user,", type=int)
+@optgroup.option("--email", "-e", help="Email address of the user.")
@click.pass_context
def cms_user_passwd(
ctx: click.Context,
@@ -212,11 +212,11 @@ def cms_user_passwd(
@cmd_user.command("modify")
@config_option
-@click.option("--admin/--no-admin", help="make the user an admin", default=None)
-@click.option("--verified/--no-verified", help="set the user verification status", default=None)
+@click.option("--admin/--no-admin", help="Make the user an admin.", default=None)
+@click.option("--verified/--no-verified", help="Set the user verification status.", default=None)
@optgroup.group("User selection", cls=RequiredMutuallyExclusiveOptionGroup)
-@optgroup.option("--id", "-i", "id_", help="database ID of the user", type=int)
-@optgroup.option("--email", "-e", help="email of the user")
+@optgroup.option("--id", "-i", "id_", help="Database ID of the user.", type=int)
+@optgroup.option("--email", "-e", help="Email address of the user.")
@click.pass_context
def cms_user_modify(
ctx: click.Context,
@@ -254,15 +254,15 @@ def cms_user_modify(
@click.option(
"--mode",
"modes",
- help="Heatmap type to generate",
+ help="Heatmap type to generate.",
type=click.Choice([mode.value for mode in hittekaart.Mode]),
multiple=True,
default=["heatmap"],
)
-@click.option("--delete", help="Delete the specified heatmap", is_flag=True)
+@click.option("--delete", help="Delete the specified heatmap.", is_flag=True)
@optgroup.group("User selection", cls=RequiredMutuallyExclusiveOptionGroup)
-@optgroup.option("--id", "-i", "id_", help="database ID of the user", type=int)
-@optgroup.option("--email", "-e", help="email of the user")
+@optgroup.option("--id", "-i", "id_", help="Database ID of the user.", type=int)
+@optgroup.option("--email", "-e", help="Email address of the user.")
@click.pass_context
def cmd_user_hittekaart(
ctx: click.Context,
@@ -313,11 +313,11 @@ def cmd_user_hittekaart(
@cli.command("maintenance-mode")
@config_option
-@click.option("--disable", help="disable the maintenance mode", is_flag=True)
+@click.option("--disable", help="Disable the maintenance mode.", is_flag=True)
@click.argument("reason", required=False)
@click.pass_context
def cmd_maintenance_mode(ctx: click.Context, config: str, disable: bool, reason: Optional[str]):
- """Check the status of the maintenance mode, or activate or deactive it.
+ """Controls the maintenance mode.
When REASON is given, enables the maintenance mode with the given text as
reason.