docs: fix usage spec syntax from 'option' to 'flag'#6834
Merged
Conversation
Replace incorrect 'option' keyword with 'flag' in usage spec examples. The usage-lib library only supports 'flag' for command-line flags, whether they take values or not. Fixed in: - docs/tasks/task-arguments.md - docs/tasks/toml-tasks.md
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR corrects documentation syntax errors in usage specifications by replacing the incorrect option keyword with the correct flag keyword. The usage-lib library only recognizes flag for command-line flags, regardless of whether they accept values.
Key Changes:
- Updated usage spec syntax from
optiontoflagfor value-accepting flags in two documentation files
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/tasks/toml-tasks.md | Changed option "--format <format>" to flag "--format <format>" in usage spec example |
| docs/tasks/task-arguments.md | Changed option "--env <env>" to flag "--env <env>" in usage spec example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.10.21 x -- echo |
18.2 ± 0.3 | 17.6 | 20.7 | 1.00 |
mise x -- echo |
18.3 ± 0.3 | 17.7 | 19.6 | 1.01 ± 0.02 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.10.21 env |
17.7 ± 0.3 | 17.3 | 21.5 | 1.00 |
mise env |
17.9 ± 0.7 | 17.3 | 23.4 | 1.01 ± 0.04 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.10.21 hook-env |
17.9 ± 0.2 | 17.4 | 18.6 | 1.00 ± 0.02 |
mise hook-env |
17.9 ± 0.2 | 17.4 | 18.7 | 1.00 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.10.21 ls |
15.4 ± 0.2 | 15.0 | 16.3 | 1.00 |
mise ls |
15.5 ± 0.5 | 15.0 | 22.1 | 1.00 ± 0.03 |
xtasks/test/perf
| Command | mise-2025.10.21 | mise | Variance |
|---|---|---|---|
| install (cached) | 106ms | 104ms | +1% |
| ls (cached) | 64ms | 63ms | +1% |
| bin-paths (cached) | 70ms | 69ms | +1% |
| task-ls (cached) | 416ms | 466ms | -10% |
jdx
pushed a commit
that referenced
this pull request
Nov 1, 2025
### 🐛 Bug Fixes - **(activate)** reset PATH when activate is called multiple times by @jdx in [#6829](#6829) - **(env)** preserve user-configured PATH entries from env._.path by @jdx in [#6835](#6835) - store tool options for all backends in metadata by @roele in [#6807](#6807) ### 📚 Documentation - fix usage spec syntax from 'option' to 'flag' by @jdx in [#6834](#6834) ### 📦️ Dependency Updates - update ghcr.io/jdx/mise:alpine docker digest to 7351bbe by @renovate[bot] in [#6826](#6826) - update ghcr.io/jdx/mise:deb docker digest to 3a847f2 by @renovate[bot] in [#6828](#6828) - update ghcr.io/jdx/mise:copr docker digest to 546dffb by @renovate[bot] in [#6827](#6827) - pin jdx/mise-action action to e3d7b8d by @renovate[bot] in [#6825](#6825)
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
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.
Replace incorrect 'option' keyword with 'flag' in usage spec examples.
The usage-lib library only supports 'flag' for command-line flags,
whether they take values or not.
Fixed in:
Note
Updates usage spec examples to use
flag(notoption) for value-taking flags in docs.flaginstead ofoptionfor value-taking flags indocs/tasks/task-arguments.md(migration guide example:--env <env>) anddocs/tasks/toml-tasks.md(recommended usage:--format <format>).Written by Cursor Bugbot for commit fdd2bbf. This will update automatically on new commits. Configure here.