Azure / Azure/azure-cli

Help Examples should be shell-sensitive

Open
#8,755 1 comment 3 reactions 1 assignee Claimed by @haroldrandom View on GitHub
Documentation feature-request
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

**Is your feature request related to a problem? Please describe.**
By convention, our examples are written to by platform agnostic. However, when we do use any kind of shell-specific syntax, we use bash syntax. The example doesn't identify this and thus CMD or Powershell users are often confused when the example doesn't work.

**Describe the solution you'd like**
We have a `supported_profiles` kwarg for examples. It might make sense to have a `supported_shell` kwarg to identify those examples that use shell-specific syntax. If the user is using an incompatible shell, the example will simply not be displayed.

In this way, we could simply add versions of the example that work for different shells.

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.