Documentation Clarity Request

[mitch-b]

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
• Content Source: latest/docs-ref-autogen/ext/azure-devops/boards/area/project.yml
• GitHub Login: @rloutlaw
• Microsoft Alias: routlaw

[arrownj]

Hi @haroldrandom , could you please help take a look at this ?

[yonzhan]

add to S166.

[mitch-b]

FWIW, my latest understanding is just updating the example to say:

Example: \ProjectName\Area\AreaName

Maybe the issue was from escaped characters when building the documentation?

[mitch-b]

This also impacts Iteration path documentation.