Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Az.Aks Xml comments #18361

Merged
merged 2 commits into from
Jun 9, 2022
Merged

Fix Az.Aks Xml comments #18361

merged 2 commits into from
Jun 9, 2022

Conversation

v-yuzhichen
Copy link
Contributor

Description

Checklist

  • I have read the Submitting Changes section of CONTRIBUTING.md
  • The title of the PR is clear and informative
  • The appropriate ChangeLog.md file(s) has been updated:
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header -- no new version header should be added
  • The PR does not introduce breaking changes
  • If applicable, the changes made in the PR have proper test coverage
  • For public API changes to cmdlets:
    • a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
      • {Please put the link here}
    • the markdown help files have been regenerated using the commands listed here


<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591</NoWarn>
</PropertyGroup>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not check in the changes in csproj file

@@ -38,8 +38,8 @@ public partial class PSContainerServiceServicePrincipalProfile
/// <param name="clientId">The ID for the service principal.</param>
/// <param name="secret">The secret password associated with the
/// service principal in plain text.</param>
/// <param name="keyVaultSecretRef">Reference to a secret stored in
/// Azure Key Vault.</param>
/// <paramef name="keyVaultSecretRef">Reference to a secret stored in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tag is wrong. Please have a look

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“XML comment has a param tag for 'keyVaultSecretRef', but there is no parameter by that name”. About this error, delete the 'keyvaultsecretref' comment?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, please remove it.

@BethanyZhou BethanyZhou merged commit bdb69d5 into Azure:main Jun 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants