Skip to content

Commit c1cfc98

Browse files
committed
minor docstring updates
1 parent a86ca2d commit c1cfc98

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/iterative_telemetry/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,15 +188,15 @@ def _system_info():
188188

189189

190190
def generate_id():
191-
"""TODO: check environ for CI-based ID"""
192-
return str(uuid.uuid4())
191+
"""A randomly generated ID string"""
192+
return str(uuid.uuid4()) # TODO: CI env-based ID
193193

194194

195195
@lru_cache(None)
196196
def _find_or_create_user_id():
197197
"""
198198
The user's ID is stored on a file under the global config directory.
199-
The file should contain JSON with a `user_id` key:
199+
The file should contain a JSON with a "user_id" key:
200200
{"user_id": "16fd2706-8baf-433b-82eb-8c7fada847da"}
201201
IDs are generated randomly with UUID4.
202202
"""

0 commit comments

Comments
 (0)