Azure / Azure/azure-cli-extensions

Documentation Clarity Request

Open
#1,253 8 comments 0 reactions 1 assignee Claimed by @mitch-b View on GitHub
customer-reported DevOps Docs Service Attention
Dominant language
Python
Stars
454
Forks
1.7k
Avg merge
2d 19h
Merged PRs (30d)
64

Description

It seems the documentation of the `--path` attribute has an Example. However, the Example is simply a value that isn't clear: `ProjectNameAreaAreaName`. If I try a similar request on my own Project, I get a failure that it isn't an absolute path. However, comparing my project to the documentation is nearly impossible to do.

Can additional clarity be added such that it's called out:

> Example: Project is "ProjectName" and listing areas underneath Area of "AreaName", supply `--path "ProjectNameAreaAreaName"`

Or is that also a misunderstanding of usage?

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: fee92b75-082a-9ec1-150b-cc34d7cedf62
* Version Independent ID: 1ea65be0-0b46-1584-c4f5-87ccb178a34c
* Content: [az boards area project](https://docs.microsoft.com/en-us/cli/azure/ext/azure-devops/boards/area/project?view=azure-cli-latest#ext-azure-devops-az-boards-area-project-list)
* Content Source: [latest/docs-ref-autogen/ext/azure-devops/boards/area/project.yml](https://github.com/MicrosoftDocs/azure-docs-cli/blob/live/latest/docs-ref-autogen/ext/azure-devops/boards/area/project.yml)
* GitHub Login: @rloutlaw
* Microsoft Alias: **routlaw**

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.