Azure-devops-docs: Argument name in the Arguments table doesn't match yaml name

Created on 8 Feb 2019  Â·  4Comments  Â·  Source: MicrosoftDocs/azure-devops-docs

It takes some guessing to do the mental map from the YAML name to the Argument description. Would it make sense to make that relation more explicit?


Document Details

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

Pri1 devops-cictech devopprod doc-bug stale-issue

Most helpful comment

Seconded. I've been working at this for awhile and it's pretty confusing.

For anyone else encountering the same problem, I found it helpful to just reference the powershell code itself: https://github.com/Microsoft/azure-pipelines-tasks/blob/master/Tasks/AzureFileCopyV3/AzureFileCopy.ps1

All 4 comments

Seconded. I've been working at this for awhile and it's pretty confusing.

For anyone else encountering the same problem, I found it helpful to just reference the powershell code itself: https://github.com/Microsoft/azure-pipelines-tasks/blob/master/Tasks/AzureFileCopyV3/AzureFileCopy.ps1

@DavidStaheli - is there a way we can autogenerate the docs to include yaml property name for the task arguments in the Docs? I can raise a PR for this specific issue, however it would be appropriate if we can automate.

In addition to @t-eckert input, you have to look at the tasks.json to then see what the names relate to:
https://github.com/microsoft/azure-pipelines-tasks/blob/master/Tasks/AzureFileCopyV3/task.json

@davidstaheli @roopeshNair this is a very stale issue and needs to be resolved in order for people to more easily use and understand this task.

This issue hasn't been updated in more than 180 days, so we've closed it. If you feel the issue is still relevant and needs fixed, please reopen it and we'll take another look. We appreciate your feedback and apologize for any inconvenience.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

cijujoseph picture cijujoseph  Â·  3Comments

o-o00o-o picture o-o00o-o  Â·  3Comments

letmaik picture letmaik  Â·  3Comments

EM1L picture EM1L  Â·  3Comments

anlatsko picture anlatsko  Â·  3Comments