Skip to content

Commit

Permalink
Fix docs cli example to give the promised run details table output (#…
Browse files Browse the repository at this point in the history
…2298)

# Description
Existing docs give wrong command line at this url; user expects to get
tabular output, but command shown gives json output:
https://microsoft.github.io/promptflow/how-to-guides/manage-runs.html#show-run-metrics

ISSUE: #2299

The 

TEST PLAN:
updated md file renders in vscode, copy & paste of corrected command
line works when a real run name is used.


# All Promptflow Contribution checklist:
- [x] **The pull request does not introduce [breaking changes].**
- [x] **CHANGELOG is updated for new features, bug fixes or other
significant changes.** (N/A)
- [x] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [x] **Create an issue and link to the pull request to get dedicated
review from promptflow team. Learn more: [suggested
workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [x] Title of the pull request is clear and informative.
- [x] There are a small number of commits, each of which have an
informative message. This means that previously merged commits do not
appear in the history of the PR. For more information on cleaning up the
commits in your PR, [see this
page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [x ] Pull request includes test coverage for the included changes.
(N/A)

Co-authored-by: BobbyO <bobbyo>
  • Loading branch information
bobbyo authored Mar 12, 2024
1 parent 77290c1 commit 163d53b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/how-to-guides/manage-runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ print(run)
Get run details with TABLE format.

```bash
pf run show --name <run-name>
pf run show-details --name <run-name>
```

![img](../media/how-to-guides/run_show_details.png)
Expand Down

0 comments on commit 163d53b

Please sign in to comment.