Modify Tasl.get_reported_scalars() docstring (#964)

See #963
This commit is contained in:
jday1 2023-03-30 15:05:18 +01:00 committed by GitHub
parent 09f8d3d848
commit 4a30e32f73
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1953,7 +1953,7 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
:param int max_samples: Maximum samples per series to return. Default is 0 returning all scalars.
With sample limit, average scalar values inside sampling window.
:param str x_axis: scalar x_axis, possible values:
'iter': iteration (default), 'timestamp': seconds from start, 'iso_time': absolute time
'iter': iteration (default), 'timestamp': timestamp as milliseconds since epoch, 'iso_time': absolute time
:return: dict: Nested scalar graphs: dict[title(str), dict[series(str), dict[axis(str), list(float)]]]
"""
if x_axis not in ('iter', 'timestamp', 'iso_time'):