Skip to content
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
merged 3 commits into from Mar 12, 2019
Merged

Added an overloads option in completed-docs #4563

merged 3 commits into from Mar 12, 2019

Conversation

JoshuaKGoldberg
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg commented Mar 2, 2019

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

Opt-in (false by default) boolean flag that can be applied to functions and methods.
@JoshuaKGoldberg
Copy link
Contributor Author

This assertion is unnecessary since it does not change the type of the expression. (no-unnecessary-type-assertion)
  593 |     }
  594 | 
> 595 |     return parent.getChildren()!;
      |           ^
  596 | }
  597 | 
  598 | function isGetAccessor(node: ts.Node): node is ts.GetAccessorDeclaration {

🤔

Copy link
Contributor

@adidahiya adidahiya left a comment

Choose a reason for hiding this comment

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

lgtm otherwise

src/rules/completedDocsRule.ts Outdated Show resolved Hide resolved
src/rules/completedDocsRule.ts Outdated Show resolved Hide resolved
@adidahiya adidahiya changed the title Added an overloads-separate-docs option in completed-docs Added an overloads option in completed-docs Mar 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

completed-docs should have an option to check every method/function overload
2 participants