Skip to content

Commit cff39c1

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

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

+11-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
import itertools
66
import logging
77
from typing import Optional
8-
from pathlib import Path
9-
import re
108

119
from tableauserverclient.server.query import QuerySet
1210

@@ -257,9 +255,19 @@ def filter(self, *invalid, page_size: Optional[int] = None, **kwargs) -> QuerySe
257255

258256
return super().filter(*invalid, page_size=page_size, **kwargs)
259257

258+
260259
def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
261260
"""
262-
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
263271
"""
264272
if identity_pool is not None:
265273
raise NotImplementedError("Identity pool is not supported in this version")

0 commit comments

Comments
 (0)