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

[Service Bus] Migrate documentation comments to TSDoc #12955

Closed
deyaaeldeen opened this issue Dec 17, 2020 · 2 comments · Fixed by #13763
Closed

[Service Bus] Migrate documentation comments to TSDoc #12955

deyaaeldeen opened this issue Dec 17, 2020 · 2 comments · Fixed by #13763
Assignees

Comments

@deyaaeldeen
Copy link
Member

deyaaeldeen commented Dec 17, 2020

Run rushx lint to see if the linting report has complains about comments. Fix issues by following the tags syntax: https://tsdoc.org/pages/tags/alpha/

@richardpark-msft
Copy link
Member

Key thing is that @ignore attributes need to be migrated to @hidden.

I believe @deyaaeldeen also checked in a tsdoc.json file that has to exist as well to allow for @hidden to work while we eliminate typedoc in our docs pipeline (this might have come in already in another PR).

@deyaaeldeen
Copy link
Member Author

@richardpark-msft that has already been done across our code base here: #12963. I also posted a PSA on our teams channel about not introducing more @ignores. But there is still a risk more @ignores could be added in packages not being checked by the linter.

@ghost ghost closed this as completed in #13763 Feb 12, 2021
ghost pushed a commit that referenced this issue Feb 12, 2021
This PR fixes the remaining errors around TSDoc 

Resolves #12955
Related to #10781
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants