Improved "complete docs" docs #3006
Conversation
There was a problem hiding this comment.
you are tageting the wrong branch and the wrong file.
This file is generated from the metadata in the rule's source. In this case src/rules/completedDocsRule.ts.
The PR should be against master. This branch is only update with the generated docs during release.
rules/completed-docs/index.html
Outdated
| @@ -1,9 +1,9 @@ | |||
| --- | |||
| ruleName: completed-docs | |||
| description: Enforces documentation for important items be filled out. | |||
| description: Enforces documentation and JSDoc comments for important items be filled out. | |||
There was a problem hiding this comment.
documentation and JSDoc comments seems redundant.
Maybe just Enforces JSDoc for important ...
There was a problem hiding this comment.
but it also works for non-JS docs? (double slash)
What about:
Enforces (JSDoc) comments for important items be filled out.
There was a problem hiding this comment.
@304NotModified Sorry for the delay
but it also works for non-JS docs? (double slash)
After looking at the code and the tests for this rule, I'm pretty sure it only checks JSDoc.
That said, I'd prefer Enforces JSDoc comments for important items be filled out.
And as stated above, the changes should be done in the rule metadata in the source file instead.
|
I've update the text and fixed |
|
and created a new PR: #3823 |
PR checklist
Overview of change:
It was unclear to me if it works for JSDocs (because in another rule "JSDoc comment" is used instead of "Documentation"
Updated the style for the inline code