Skip to content

Commit 257485a

Browse files
committed
docs: create_users_csv docstring
1 parent 233f194 commit 257485a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

Diff for: tableauserverclient/server/endpoint/users_endpoint.py

+11-1
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,19 @@ def filter(self, *invalid, page_size: Optional[int] = None, **kwargs) -> QuerySe
257257

258258
return super().filter(*invalid, page_size=page_size, **kwargs)
259259

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

0 commit comments

Comments
 (0)