docs: create_users_csv docstring

tableau · Aug 23, 2024 · d91bb1d · d91bb1d
1 parent 5909a7e
commit d91bb1d
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/tableauserverclient/server/endpoint/users_endpoint.py b/tableauserverclient/server/endpoint/users_endpoint.py
@@ -258,7 +258,16 @@ def _get_groups_for_user(
 
 def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
     """
-    Create a CSV byte string from an Iterable of UserItem objects
+    Create a CSV byte string from an Iterable of UserItem objects. The CSV will
+    have the following columns, and no header row:
+
+    - Username
+    - Password
+    - Display Name
+    - License
+    - Admin Level
+    - Publish capability
+    - Email
     """
     if identity_pool is not None:
         raise NotImplementedError("Identity pool is not supported in this version")