Eslint-plugin-jsdoc: require-description-complete-sentence: false positive with Markdown table

Created on 8 Nov 2019  路  3Comments  路  Source: gajus/eslint-plugin-jsdoc

If I have a comment which contains a Markdown table:

/**
 * This method is working on 2聽steps.
 *
 * | Step | Comment     |
 * |------|-------------|
 * |   1  | do it       |
 * |   2  | do it again |
 */

The rule require-description-complete-sentence requires/adds a period after the table.

bug released
Source
picture sveyret

All 3 comments

:tada: This issue has been resolved in version 17.1.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

gajus picture gajus on 8 Nov 2019
👍1

What about tables like:

Still |   a
----- | -----
valid | table

Still | a
----- | -----
valid | table

ExE-Boss picture ExE-Boss on 8 Nov 2019

@ExE-Boss : Yeah, there are so many possibilities here. Unless we are going to install a Markdown processor and/or grammar processor, I don't think we can adequately address all cases for this rule.

brettz9 picture brettz9 on 8 Nov 2019
👍1
Was this page helpful?
0 / 5 - 0 ratings

Related issues

rasenplanscher picture rasenplanscher  路  3Comments
AndrewLeedham picture AndrewLeedham  路  3Comments
MaxMilton picture MaxMilton  路  4Comments
yvele picture yvele  路  4Comments
pgoldrbx picture pgoldrbx  路  3Comments