search

Azure / azure-cli

Azure Command-Line Interface
MIT License
3.96k stars 2.94k forks source link

Customer feedback | az storage queue | No output example in documentation #29462

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

Describe the bug

This GitHub issue is being copied from azure-docs-cli 4475 for engineering team awareness.

Suggestion: Until we have an output property for our autogenerated reference content, consider using the long-summary property to return possible command output. Please see @dcaro for additional feedback / ideas.

Type of issue Missing information

Feedback Articles like this shows all inputs but does not provide any example output, making it hard for developers to understand which information is provided by each command.

Page URL https://learn.microsoft.com/en-us/cli/azure/storage/queue?view=azure-cli-latest

Content source URL https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/storage/queue.yml

Related command

az storage queue

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

n/a

Additional context

No response

yonzhan commented 1 month ago

Thank you for opening this issue, we will look into it.

calvinhzy commented 1 month ago

This will be a long term effort to add output examples as currently only some tutorials have sample output. Looking into using swagger to get a sample output.