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.

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

[Event Hubs] Migrate documentation comments to TSDoc #12953

Closed
2 of 3 tasks
deyaaeldeen opened this issue Dec 17, 2020 · 1 comment
Closed
2 of 3 tasks

[Event Hubs] Migrate documentation comments to TSDoc #12953

deyaaeldeen opened this issue Dec 17, 2020 · 1 comment
Assignees
@ramya-rao-a @chradek
Labels
Event Hubs

Comments

@deyaaeldeen
Copy link
Member

deyaaeldeen commented Dec 17, 2020 •
edited
Loading

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/

  • eventhubs-checkpointstore-blob
  • event-processor-host
  • event-hubs
@deyaaeldeen deyaaeldeen added this to the Backlog milestone Dec 17, 2020
@deyaaeldeen deyaaeldeen mentioned this issue Dec 17, 2020
Closed
12 tasks
This was referenced Feb 6, 2021
Merged
Merged
ghost pushed a commit that referenced this issue Feb 6, 2021
@ramya-rao-a
[Event Hubs] Remove use of @Property tag in docs (#13637)
7b34c24 
This PR resolves about 150 linter errors around the use of `@property` tag which is not allowed in TSDoc

Related to #12953
ghost pushed a commit that referenced this issue Feb 6, 2021
@ramya-rao-a
[Event Hubs] Remove invalid tsdoc tags (#13638)
39041ef 
This PR removes the below invalid TSDoc tags fixing about 20 linting errors
- `@class`
- `@ignore`
- `@constructor`

Additionally, 
- it removes the `@hidden` tag if  `@internal` is already applied
- it removes the `@hidden` or `internal` tag on a interface/class member if the interface/class itself already has one of the two tags

Related to #12953
This was referenced Feb 6, 2021
Merged
Merged
Merged
ghost pushed a commit that referenced this issue Feb 11, 2021
@ramya-rao-a
[Event Hubs] Fix remaining TSDoc linting errors (#13746)
753b891 
This PR fixes the remaining TSDoc related linting errors in Event Hubs, thereby reducing the number of total linter problems from 70 to 38. Related to #12953 and #10777

@chradek Of the 38, errors are 18 and warnings are 20. Handing over the rest to your capable hands!
@ramya-rao-a
Copy link
Contributor

Event Hubs and the checkpoint store packages have been updated
We wont be touching the event-processor-host as it is not in active development

@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.
Assignees

@ramya-rao-a ramya-rao-a

@chradek chradek

Labels
Event Hubs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@xirzec @deyaaeldeen @ramya-rao-a @chradek