Skip to content

docs(cli): clarify --output flag behavior in ado get operations --help documentation #700

@danielelotito

Description

@danielelotito

The documentation for the --output (-o) flag within the ado get operations --help (or similar) command is not entirely clear regarding the behavior of yaml, json, and raw output formats. While these formats correctly output the entire resource, the --help description does not explicitly state this, which can cause ambiguity especially when working with agents which use --help a lot.

Currently, the help text reads:

--output -o [config|default|json|raw|yaml] Output information in a different format. Not all formats may be supported by all resources.

This general description does not convey that yaml, json, and raw are designed to display the complete resource details, unlike config or default which might provide a summarized view.

Proposed Improvement
Update the --output flag documentation in ado get operations --help to explicitly state that json, raw, and yaml formats provide a comprehensive representation of the resource.

Example of revised text:
--output -o [config|default|json|raw|yaml] Output information in a different format. The 'json', 'raw', and 'yaml' formats will output the entire resource. Not all formats may be supported by all resources.

IMPORTANT TODO FOR THE FUTURE
Update the relevant help text in similar commands as well.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions