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

[Cosmos] Be TSDoc compliant #13801

Closed
wants to merge 3 commits into from
Closed

Conversation

ramya-rao-a
Copy link
Contributor

@ramya-rao-a ramya-rao-a commented Feb 16, 2021

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:

  • Remove type info from @param and @returns tags. TS tooling can infer this without us adding to these tags
  • Remove the @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.
  • Use the hypen as a delimitor between parameter name and description when using the @param tag
  • Remove @hidden tag if @internal is already applied
  • Remove JSDoc tags that make sense in JS files, but not are not required in TS files and so are invalid in TSDoc.
    • @class
    • @constructor
    • @interface
    • @instance
    • @memberof
    • @summary
    • @description
  • In some cases, I found stale docs detailing parameters that are no longer used in the methods. I have deleted such entries
  • Use backticks where applicable to avoid the linter from thinking that presence of {, } is some kind of TSDoc entity
  • Remove trailing backslash in the end of a line. I believe this was added to denote that the text continues in the next line. This is invalid in TSDoc, and I am not aware of any tooling that relies on this. Please do share if any such tooling exists

@zfoster
Copy link
Contributor

zfoster commented Feb 16, 2021

I'm taking a look at this - pulling down since I see some issues with jsdoc formatting

@ramya-rao-a
Copy link
Contributor Author

@zfoster Fixed the formatting and build errors!

@zfoster
Copy link
Contributor

zfoster commented Feb 16, 2021

ah, I did too 👍 i'll review now

@zfoster
Copy link
Contributor

zfoster commented Feb 16, 2021

/azp run js - cosmosdb - ci

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@ghost
Copy link

ghost commented Feb 16, 2021

Hello @ramya-rao-a!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

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 (@msftbot) and give me an instruction to get started! Learn more here.

@ramya-rao-a
Copy link
Contributor Author

Closing in favor of #13849

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Cosmos] Migrate documentation comments to TSDoc
2 participants