Commit 9a08c65
authored
Fix outputs documentation with correct parameter syntax (#508)
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)
---
- [x] "I certify that all code in this PR is my own, except as noted
below."
## Use of AI
- [x] Includes AI-assisted code completion
- [ ] Includes code generated by an AI application
- [ ] Includes AI-generated tests (NOTE: AI written tests should have a
docstring that includes `## WRITTEN BY AI ##`)1 file changed
+68
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
70 | 136 | | |
71 | 137 | | |
72 | 138 | | |
| |||
75 | 141 | | |
76 | 142 | | |
77 | 143 | | |
78 | | - | |
| 144 | + | |
79 | 145 | | |
80 | 146 | | |
81 | 147 | | |
| |||
0 commit comments