This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Added an overloads option in completed-docs #4563
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR checklist
Overview of change:
Opt-in (false by default) boolean flag that can be applied to functions and methods to require their overloads each receive their own documentation comment.
Also deleted a bunch of unnecessary
tsconfig.json
files that were still in the tests directory for completed-docs. I should have removed them when converting it to TypeScript.CHANGELOG.md entry:
[new-rule-option]
completed-docs
:overloads
option to enforce documentation of each overload signature