Skip to content

Commit

Permalink
Improve WindowsSessionUser doscstring
Browse files Browse the repository at this point in the history
Signed-off-by: Robert Luttrell <[email protected]>
  • Loading branch information
roblutt committed Oct 10, 2023
1 parent f34d319 commit fb07f18
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/openjd/sessions/_session_user.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,12 @@ def is_domain_joined() -> bool:
def __init__(self, user: str, *, group: str) -> None:
"""
Arguments:
user (str): The user
group (str): The group
user (str): User name of the identity to run the Session's subprocesses under.
This can be either a plain username for a local user or a domain username in down-level logon form
ex: localUser, domain\\domainUser, [email protected]
group (str): Group name of the identity to run the Session's subprocesses under.
This can be just a group name for a local group, or a domain group in down-level format.
ex: localGroup, domain\\domainGroup
"""
if not is_windows():
raise RuntimeError("Only available on Windows systems.")
Expand Down

0 comments on commit fb07f18

Please sign in to comment.