-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[Cosmos] Be TSDoc compliant #13801
Closed
Closed
[Cosmos] Be TSDoc compliant #13801
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
Cosmos
label
Feb 16, 2021
I'm taking a look at this - pulling down since I see some issues with jsdoc formatting |
ramya-rao-a
requested review from
bterlson,
chradek and
xirzec
as code owners
February 16, 2021 17:50
@zfoster Fixed the formatting and build errors! |
ah, I did too 👍 i'll review now |
zfoster
approved these changes
Feb 16, 2021
/azp run js - cosmosdb - ci |
Azure Pipelines successfully started running 1 pipeline(s). |
Hello @ramya-rao-a! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
Closing in favor of #13849 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the cosmosdb package to be TSDoc compliant. See #12912 for why we are making the move from JSDoc to TSDoc. Resolves #12951
Majority of the changes in this PR fall under the below categories:
@param
and@returns
tags. TS tooling can infer this without us adding to these tags@param
tag if only the parameter name is present without parameter description. Such instances add no value to TS tooling. This can also serve as a reminder to add relevant description. Feel free to provide suggested edits in this PR for such cases.@param
tag@hidden
tag if@internal
is already applied@class
@constructor
@interface
@instance
@memberof
@summary
@description
{
,}
is some kind of TSDoc entity