Skip to content

docs: fix export-bash-scripts flag from --out to --output - #2148

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-export-bash-scripts-flag-9cb171f7b64bd095
Draft

github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-export-bash-scripts-flag-9cb171f7b64bd095

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
accuracy Example commands used export-bash-scripts --out <dir>, but the actual clap flag defined in src/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

  • Changed cargo run -- export-bash-scripts --out /tmp/ado-aw-shell to --output in AGENTS.md (Bash step lint section).
  • Changed both --out occurrences to --output in docs/extending.md ("Reviewing the scripts as files" section), including the --format json variant.

Notes

Verified against the Commands::ExportBashScripts variant in src/main.rs, which declares output: std::path::PathBuf with #[arg(short, long)] — i.e. -o/--output only. docs/cli.md already documented the correct --output flag, so this fix brings AGENTS.md and docs/extending.md in line with it and with the actual CLI surface. No other --out occurrences were found elsewhere in docs/**, AGENTS.md, or prompts/**.


Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · auto · 67.9 AIC · ⌖ 6.37 AIC · ⊞ 12.4K ·

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

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants