Skip to content

update doc comments per TSDoc standard #36

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 25, 2023
Merged

update doc comments per TSDoc standard #36

merged 1 commit into from
Dec 25, 2023

Conversation

@Eskibear
Copy link
Member

@Eskibear Eskibear commented Dec 25, 2023

This PR follows the TSDoc standard to update the doc comments, providing better intellisense.

  • optimize for type SettingSelector, adding comments for keyFilter and labelFilter respectively.
  • using @remarks tag

@Eskibear
Copy link
Member Author

Eskibear commented Dec 25, 2023

E.g. for keyFilter previously the description is bound with type SettingSelector and won't show up directly on keyFilter property as below:

image

now it's more helpful:
image

juniwang
juniwang approved these changes Dec 25, 2023
View reviewed changes
Copy link
Member

@juniwang juniwang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Eskibear Eskibear merged commit 0adf2ff into main Dec 25, 2023
@Eskibear Eskibear deleted the tsdoc branch December 25, 2023 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@juniwang juniwang juniwang approved these changes

@avanigupta avanigupta Awaiting requested review from avanigupta

@zhiyuanliang-ms zhiyuanliang-ms Awaiting requested review from zhiyuanliang-ms

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Eskibear @juniwang