Skip to content

Commit

Permalink
feat(framework) Update flwr ls docstring (#4713)
Browse files Browse the repository at this point in the history
  • Loading branch information
chongshenng authored Dec 16, 2024
1 parent a858212 commit 3f8c541
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion src/py/flwr/cli/ls.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,20 @@ def ls( # pylint: disable=too-many-locals, too-many-branches
),
] = CliOutputFormat.DEFAULT,
) -> None:
"""List runs."""
"""List the details of one provided run ID or all runs in a Flower federation.
The following details are displayed:
- **Run ID:** Unique identifier for the run.
- **FAB:** Name of the FAB associated with the run (``{FAB_ID} (v{FAB_VERSION})``).
- **Status:** Current status of the run (pending, starting, running, finished).
- **Elapsed:** Time elapsed since the run started (``HH:MM:SS``).
- **Created At:** Timestamp when the run was created.
- **Running At:** Timestamp when the run started running.
- **Finished At:** Timestamp when the run finished.
All timestamps follow ISO 8601, UTC and are formatted as ``YYYY-MM-DD HH:MM:SSZ``.
"""
suppress_output = output_format == CliOutputFormat.JSON
captured_output = io.StringIO()
try:
Expand Down

0 comments on commit 3f8c541

Please sign in to comment.