Skip to content

Commit e19405f

Browse files
authored
better help messages (#357)
* better help messages * adjust docs
1 parent 5348668 commit e19405f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/code42cli/cmds/users.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,9 @@ def change_organization(state, username, org_id):
234234
@click.argument("alias")
235235
@sdk_options()
236236
def add_alias(state, username, alias):
237-
"""Add a cloud alias for a given user."""
237+
"""Add a cloud alias for a given user.
238+
239+
A cloud alias is the username an employee uses to access cloud services such as Google Drive or Box. Adding a cloud alias allows Incydr to link a user's cloud activity with their Code42 username. Each user has a default cloud alias of their Code42 username. You can add one additional alias."""
238240
_add_cloud_alias(state.sdk, username, alias)
239241

240242

@@ -251,7 +253,7 @@ def remove_alias(state, username, alias):
251253
@click.argument("username")
252254
@sdk_options()
253255
def list_aliases(state, username):
254-
"""List the cloud aliases for a given user."""
256+
"""List the cloud aliases for a given user. Each user has a default cloud alias of their Code42 username with up to one additional alias."""
255257
user = _get_user(state.sdk, username)
256258
aliases = user["cloudUsernames"]
257259
if aliases:
@@ -577,7 +579,7 @@ def handle_row(**row):
577579

578580
@bulk.command(
579581
name="add-alias",
580-
help=f"Add aliases to a list of users from the provided CSV in format: {','.join(_bulk_user_alias_headers)}",
582+
help=f"Add aliases to a list of users from the provided CSV in format: {','.join(_bulk_user_alias_headers)}.\n\nA cloud alias is the username an employee uses to access cloud services such as Google Drive or Box. Adding a cloud alias allows Incydr to link a user's cloud activity with their Code42 username. Each user has a default cloud alias of their Code42 username. You can add one additional alias.",
581583
)
582584
@read_csv_arg(headers=_bulk_user_alias_headers)
583585
@format_option

0 commit comments

Comments
 (0)