docs: fix export-bash-scripts flag from --out to --output - #2148
Draft
github-actions[bot] wants to merge 1 commit into
Draft
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
The clap CLI defines the export-bash-scripts output path as --output/-o (src/main.rs Commands::ExportBashScripts), not --out. AGENTS.md and docs/extending.md examples used --out, which fails with an unrecognized-argument error if copy-pasted since clap does not have short/long flag inference enabled. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
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.
Agent Documentation Update
Findings
export-bash-scripts --out <dir>, but the actual clap flag defined insrc/main.rs(Commands::ExportBashScripts { output: PathBuf, ... }with#[arg(short, long)]) is--output(or-o), not--out. Since this project does not enable clap flag inference, copy-pasting the documented command fails with an unrecognized-argument error.AGENTS.md,docs/extending.md(2 occurrences)Applied Fixes
cargo run -- export-bash-scripts --out /tmp/ado-aw-shellto--outputinAGENTS.md(Bash step lint section).--outoccurrences to--outputindocs/extending.md("Reviewing the scripts as files" section), including the--format jsonvariant.Notes
Verified against the
Commands::ExportBashScriptsvariant insrc/main.rs, which declaresoutput: std::path::PathBufwith#[arg(short, long)]— i.e.-o/--outputonly.docs/cli.mdalready documented the correct--outputflag, so this fix bringsAGENTS.mdanddocs/extending.mdin line with it and with the actual CLI surface. No other--outoccurrences were found elsewhere indocs/**,AGENTS.md, orprompts/**.Created by the agent-documentation maintainer workflow.