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

[keyvault] fix doc comments #21410

Merged
merged 3 commits into from
Aug 22, 2023
Merged

Conversation

gracewilcox
Copy link
Member

When we changed some of the names, not all the doc comments were changed to match the new names. This pull request that issue and updates the doc comments

@gracewilcox gracewilcox added KeyVault Client This issue points to a problem in the data-plane of the library. labels Aug 21, 2023
@chlowell
Copy link
Member

What do you think of rewriting the comments to remove the redundant type name e.g. "// Elliptic curve name. For valid values, see CurveName."? I'm thinking, people reading the comment have the type or its name in front of them, and in the rendered docs type names link to definitions

@gracewilcox gracewilcox merged commit 446ca6b into Azure:main Aug 22, 2023
@gracewilcox gracewilcox deleted the update-doc-comments branch August 22, 2023 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. KeyVault
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants