Update lib/pure/os.nim docs

Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
rominf · Feb 11, 2021 · e52653a · e52653a
1 parent abb5127
commit e52653a
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/pure/os.nim b/lib/pure/os.nim
@@ -1649,8 +1649,8 @@ proc setFilePermissions*(filename: string, permissions: set[FilePermission],
     if res2 == - 1'i32: raiseOSError(osLastError(), $(filename, permissions))
 
 proc isAdmin*: bool {.noWeirdTarget.} =
-  ## Tell whether the caller's process is a member of the Administrators local
-  ## group (on Windows) or a root (on POSIX).
+  ## Returns whether the caller's process is a member of the Administrators local
+  ## group (on Windows) or a root (on POSIX), via `geteuid() == 0`.
   when defined(windows):
     # Rewrite of the example from Microsoft Docs:
     # https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-checktokenmembership#examples