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

[#2602] [JSDoc] Add missing documentation for botframework-streaming #2826

Merged
merged 7 commits into from
Oct 19, 2020
Merged

[#2602] [JSDoc] Add missing documentation for botframework-streaming #2826

merged 7 commits into from
Oct 19, 2020

Conversation

denscollo
Copy link
Contributor

@denscollo denscollo commented Sep 30, 2020 •
edited
Loading

Addresses #2602

Description

This PR introduces the change to jsdoc/require-jsdoc in the .eslintrc.json file from warn to error and adds all the missing JSDoc documentation for botframework-streaming based on the errors thrown. Some documentation is ported and adapted from botbuilder-dotnet

Note: We divided the work for this library into two PRs to ease the review.

Specific Changes

  • Updated jsdoc/require-jsdoc in .eslintrc.json from warn to error.
  • Private methods' documentation that does not exist on botbuilder-dotnet we added the @private tag in the JSDoc comment.
  • Added JSDoc comments in 16 files.

Testing

In the following image there is a sneak peek about the ESLint Report with no JSDoc errors.
image

@denscollo denscollo requested review from a team as code owners September 30, 2020 20:54
joshgummersall
joshgummersall approved these changes Sep 30, 2020
View reviewed changes
Copy link
Contributor

@joshgummersall joshgummersall left a comment •
edited
Loading

Choose a reason for hiding this comment

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

See comment below.

@joshgummersall joshgummersall added the Area: Docs Documentation issue (missing needs updates, etc.) label Oct 6, 2020
joshgummersall
joshgummersall suggested changes Oct 6, 2020
View reviewed changes
Copy link
Contributor

@joshgummersall joshgummersall left a comment

Choose a reason for hiding this comment

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

In an effort to improve generated docs, properly linking types with [link text](xref:uid) would be really helpful.

See more details here and here.

santgr11 and others added 2 commits October 9, 2020 12:28
@santgr11
Apply xref updates
f31530c
@denscollo
Merge pull request #187 from southworks/internal/jsdoc/botframework-s…
0bb3586 
…treaming

Apply xref links for southworks/add/jsdoc/botframework streaming
@joshgummersall joshgummersall merged commit 08a3069 into microsoft:main Oct 19, 2020
@denscollo denscollo deleted the southworks/add/jsdoc/botframework-streaming branch October 19, 2020 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshgummersall joshgummersall joshgummersall approved these changes

Assignees
No one assigned
Labels
Area: Docs Documentation issue (missing needs updates, etc.)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@denscollo @joshgummersall @sw-joelmut @santgr11