Add docstring to explain param

This commit is contained in:
Lance Edgar 2023-11-06 21:25:13 -06:00
parent c13e9ff23c
commit 6a15b5ae5e

View file

@ -129,11 +129,15 @@ def mkdir(c, paths, owner=None, mode=None,
def make_normal_user(c, username, full_name=None,
# TODO: ugh why is this true by default..should change that
disabled_login=True,
password=None):
"""
Make a new "normal" user account.
:param disabled_login: If true (the default), add the
``--disabled-login`` flag to the ``adduser`` command. The
reason this is the default, is to avoid being prompted for a
password to give the new account.
"""
if not c.run('getent passwd {}'.format(username), warn=True).failed:
return