Skip to content

Update typedoc comments #1264

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 22 commits into from
Oct 22, 2019
Merged

Update typedoc comments #1264

merged 22 commits into from
Oct 22, 2019

Conversation

JonathanFingold
Copy link
Contributor

@JonathanFingold JonathanFingold commented Oct 7, 2019 •
edited
Loading

Description

Updates documentation in the touched files.

Specific Changes

  • Improving ref doc content: fix links, copy edit, use MS style guidelines.

Testing

  • Performed local build and visual review of the updated docs.

@coveralls
Copy link

coveralls commented Oct 7, 2019 •
edited
Loading

Pull Request Test Coverage Report for Build 84777

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.703%
Totals Coverage Status
Change from base Build 84774: 0.0%
Covered Lines: 4916
Relevant Lines: 5393
💛 - Coveralls

@cleemullins
Copy link
Contributor

Please update this PR to be a "DRAFT" PR until it's ready.

@cleemullins
Copy link
Contributor

Please update this PR so we can merge it. Smaller, focused, PR's are better than large ones that linger for months.

@JonathanFingold JonathanFingold changed the title [DO NOT MERGE] Update typedoc comments Update typedoc comments Oct 21, 2019
@JonathanFingold
Copy link
Contributor Author

Please update this PR so we can merge it. Smaller, focused, PR's are better than large ones that linger for months.

Sorry about that. Some of my work got tabled while two classes were refactored. I'll keep these more contained going forward.

Stevenic
Stevenic approved these changes Oct 22, 2019
View reviewed changes
Copy link
Contributor

@Stevenic Stevenic left a comment

Choose a reason for hiding this comment

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

:shipit:

@Stevenic Stevenic merged commit 8bfc4f1 into master Oct 22, 2019
@Stevenic Stevenic deleted the jf/typedoc-0916 branch October 22, 2019 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cleemullins cleemullins Awaiting requested review from cleemullins

1 more reviewer

@Stevenic Stevenic Stevenic approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@JonathanFingold @coveralls @cleemullins @Stevenic