Azure / Azure/azure-cli

JSON output should be documented as part of ref

Open
#5,761 5 comments 1 reaction 1 assignee Claimed by @haroldrandom View on GitHub
Documentation feature-request
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 22h
Merged PRs (30d)
64

Description

Since information in JSON output is custom-formatted and does not necessary align with either REST API or Python SDK, and users should not be directed to that documentation anyway when using the CLI, there needs to be a way in reference to give information on output for CLI commands. This should probably __not__ be displayed as part of inline help (even detailed help), but rather as part of the online web help.

(x-ref azure/azure-docs-cli-python#604)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.