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

[storage] migrate from JSDoc to TSDoc #13431

Closed
ljian3377 opened this issue Jan 28, 2021 · 1 comment
Closed

[storage] migrate from JSDoc to TSDoc #13431

ljian3377 opened this issue Jan 28, 2021 · 1 comment
Assignees
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. Docs Storage Storage Service (Queues, Blobs, Files)

Comments

@ljian3377
Copy link
Member

https://teams.microsoft.com/l/message/19:344f6b5b36ba414daa15473942c7477b@thread.skype/1608171348573?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1608171348573&teamName=Azure%20SDK&channelName=Language%20%E2%80%93%20JS%E2%80%89%EF%BC%86%E2%80%89TS%20%F0%9F%90%B1%E2%80%8D%F0%9F%91%A4&createdTime=1608171348573

#12912

Now you can run rushx docs and you will see the generated documentation for your package under dist/docs. Hopefully, this will help us write high quality documentation for our packages and fix issues right away before them making it all the way to docs.microsoft.com. - D A

The various js tags like @type, @interface, @member, @class, @private and @constructor that are no longer useful in TS files and the different formatting for @param lines in jsdocs and the redundant inclusion of type info in @returns tag had always bothered me. Love seeing them go :) - Ramya

Address #12959 for storage.

@ljian3377 ljian3377 added bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files) Docs labels Jan 28, 2021
@ljian3377 ljian3377 added this to the Backlog milestone Jan 28, 2021
@ljian3377 ljian3377 self-assigned this Jan 28, 2021
@deyaaeldeen
Copy link
Member

Hi @ljian3377, I already have this issue open for storage: #12956 so I am closing this one.

@xirzec xirzec removed this from the Backlog milestone May 17, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. Docs Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

No branches or pull requests

3 participants