Skip to content
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.

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

Enforce jsdoc/check-indentation #252

Open
edg2s opened this issue May 14, 2020 · 0 comments
Open

Enforce jsdoc/check-indentation #252

edg2s opened this issue May 14, 2020 · 0 comments

Comments

@edg2s
Copy link
Member

edg2s commented May 14, 2020

This rule was pulled out of #211 because it caused too many false positives:

  • It doesn't like "indents" for continued text describing parameters/etc. which makes a serious mess of some of our VE stuff.

This can be fixed by adding param/return to the excludeTags option (in addition to example). This would still leave descriptions containing bullet lists (1 in VE, probably more in core), so we could just disable the rule, it doesn't catch a huge amount.

If we managed to fix the rule to allow indentation of all multi-line text blocks, the only errors we would catch would be ·*··@tag -> ·*·@tag.

Update: Should probably be disabled without gajus/eslint-plugin-jsdoc#541. Lots of false positives in mw-core.

That can be revisited if gajus/eslint-plugin-jsdoc#541 gets resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant