From 1e1e33fe0273970ac8e184f125e6f0a8f3bac0e7 Mon Sep 17 00:00:00 2001
From: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Date: Wed, 10 Jul 2024 21:22:16 -0500
Subject: [PATCH] docs: create_users_csv docstring
---
tableauserverclient/server/endpoint/users_endpoint.py | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/tableauserverclient/server/endpoint/users_endpoint.py b/tableauserverclient/server/endpoint/users_endpoint.py
index a6e81d42..5bf43e64 100644
--- a/tableauserverclient/server/endpoint/users_endpoint.py
+++ b/tableauserverclient/server/endpoint/users_endpoint.py
@@ -220,7 +220,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")