Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs cli example to give the promised run details table output #2298

Merged
merged 1 commit into from
Mar 12, 2024

Conversation

bobbyo
Copy link
Contributor

@bobbyo bobbyo commented Mar 11, 2024

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:

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

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • 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.

Testing Guidelines

  • [x ] Pull request includes test coverage for the included changes. (N/A)

@bobbyo bobbyo requested a review from a team as a code owner March 11, 2024 19:37
@github-actions github-actions bot added documentation Improvements or additions to documentation external labels Mar 11, 2024
@wangchao1230 wangchao1230 merged commit 163d53b into microsoft:main Mar 12, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation external
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants