docs: improve examples on several command line arguments. #310
Conversation
This file contains 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
caarlos0
reviewed
Sep 10, 2024
| - `--format-as`: Specify the format for the output (used with `--format`). | ||
| - `-P`, `--prompt`: Prompt should include stdin and args. | ||
| - `-p`, `--prompt-args`: Prompt should only include args. | ||
| - `--format-as`: Specify the format for the output (used with `--format`, e.g. `mods -f --format-as json 'your prompt here'`). |
There was a problem hiding this comment.
the other flags don't have example usages in their help, i think this should be somewhere else
Suggested change
| - `--format-as`: Specify the format for the output (used with `--format`, e.g. `mods -f --format-as json 'your prompt here'`). | |
| - `--format-as`: Specify the format for the output (used with `--format`). |
| - `-P`, `--prompt`: Prompt should include stdin and args. | ||
| - `-p`, `--prompt-args`: Prompt should only include args. | ||
| - `--format-as`: Specify the format for the output (used with `--format`, e.g. `mods -f --format-as json 'your prompt here'`). | ||
| - `-P=n`, `--prompt=n`: show the output with prompts from stdin, and only include the first `n` lines of prompt. |
There was a problem hiding this comment.
Suggested change
| - `-P=n`, `--prompt=n`: show the output with prompts from stdin, and only include the first `n` lines of prompt. | |
| - `-P`, `--prompt`: show the output with the prompt from STDIN, and only include the first `n` lines of the prompt. |
| @@ -40,7 +40,7 @@ var help = map[string]string{ | |||
| "role": "System role to use.", | |||
| "roles": "List of predefined system messages that can be used as roles.", | |||
| "list-roles": "List the roles defined in your configuration file", | |||
| "prompt": "Include the prompt from the arguments and stdin, truncate stdin to specified number of lines.", | |||
| "prompt": "Include the top n lines of prompt from the stdin in the response, where n is the specified number.", | |||
There was a problem hiding this comment.
Suggested change
| "prompt": "Include the top n lines of prompt from the stdin in the response, where n is the specified number.", | |
| "prompt": "Include the first n lines of prompt from the STDIN in the response", |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.