Fix outputs documentation with correct parameter syntax #508
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sjmonson
requested changes
Dec 8, 2025
Collaborator
sjmonson
left a comment
sjmonson
left a comment
There was a problem hiding this comment.
One minor nit otherwise LGTM.
maryamtahhan
force-pushed
the
hotfix-docs-output
branch
from
76b5d0b to
669d3df
Compare
Contributor
Author
Collaborator
Collaborator
|
Quality checks failed. Can you please run |
maryamtahhan
force-pushed
the
hotfix-docs-output
branch
from
669d3df to
3ef1aea
Compare
Contributor
Author
Apologies - this should be fixed now. |
sjmonson
force-pushed
the
hotfix-docs-output
branch
from
3ef1aea to
83d8977
Compare
Correct the --outputs parameter examples to show comma-separated values instead of space-separated, which doesn't work in all environments. The parameter supports comma-separated format aliases or multiple flags. Signed-off-by: Maryam Tahhan <[email protected]>
sjmonson
force-pushed
the
hotfix-docs-output
branch
from
83d8977 to
cc80859
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Correct the --outputs parameter examples to show comma-separated values instead of space-separated, which doesn't work in all environments. The parameter supports comma-separated format aliases or multiple flags.
Summary
The documentation for the --outputs parameter incorrectly showed space-separated values (e.g., --outputs json csv html) which doesn't work in all environments. This PR updates all examples to use the correct comma-separated syntax (e.g., --outputs json,csv,html) or multiple flags approach, ensuring users can successfully generate multiple output formats.
Details
Updated "Specifying Output Formats" section in docs/guides/outputs.md to clarify correct syntax
Test Plan
Verify the examples work in different environments:
Direct CLI: guidellm benchmark --outputs "json,csv,html" ...
Multiple flags: guidellm benchmark --outputs json --outputs csv --outputs html ...
Docker/Podman with env vars: -e GUIDELLM_OUTPUTS="json,csv,html"
Confirm all three output files (JSON, CSV, HTML) are generated in the output directory
Related Issues
N/A (Documentation correction)
Use of AI
## WRITTEN BY AI ##)