Skip to content

Commit a8d1ad5

Browse files
committed
docs: create_users_csv docstring
1 parent 3b0c157 commit a8d1ad5

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,16 @@ def _get_groups_for_user(
258258

259259
def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
260260
"""
261-
Create a CSV byte string from an Iterable of UserItem objects
261+
Create a CSV byte string from an Iterable of UserItem objects. The CSV will
262+
have the following columns, and no header row:
263+
264+
- Username
265+
- Password
266+
- Display Name
267+
- License
268+
- Admin Level
269+
- Publish capability
270+
- Email
262271
"""
263272
if identity_pool is not None:
264273
raise NotImplementedError("Identity pool is not supported in this version")

0 commit comments

Comments
 (0)