Skip to content

Commit 1e1e33f

Browse files
committed
docs: create_users_csv docstring
1 parent 4186bd0 commit 1e1e33f

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
@@ -220,7 +220,16 @@ def _get_groups_for_user(
220220

221221
def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
222222
"""
223-
Create a CSV byte string from an Iterable of UserItem objects
223+
Create a CSV byte string from an Iterable of UserItem objects. The CSV will
224+
have the following columns, and no header row:
225+
226+
- Username
227+
- Password
228+
- Display Name
229+
- License
230+
- Admin Level
231+
- Publish capability
232+
- Email
224233
"""
225234
if identity_pool is not None:
226235
raise NotImplementedError("Identity pool is not supported in this version")

0 commit comments

Comments
 (0)