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

Revert JSDoc plugin #291

Merged
merged 1 commit into from Jan 29, 2018
Merged

Revert JSDoc plugin #291

merged 1 commit into from Jan 29, 2018

Conversation

pvdlg
Copy link
Contributor

@pvdlg pvdlg commented Jan 29, 2018

Per comment those new rules have several bugs.

/**
 * Sentence with a word stating with a
 * Capital letter.
 */

Returns an error, even though it should be valid to break the line and sometimes the break happen before a capitalize word.

/**
 * List of things:
 * - elem 1
 * - elem 2
 */

Returns an error even though doing a list should be perfectly valid in JSDoc.

/**
 * Code example:
 * ```js
 * console.log(test)
 * ```
 */

Once again returns an error even though perfectly valid.

All the following situation might create an issue:

  • Using capital letter in the middle of a sentence
  • Using list
  • Using colon (:) + new line to describe something
  • Using code example
  • Using mardown

We should remove those rules until they work properly.
@simonepri as you requested those rules in the first place, maybe you could open issues with the eslint-plugin-jsdoc project?

@sindresorhus sindresorhus merged commit 61a85cf into xojs:master Jan 29, 2018
@simonepri
Copy link

simonepri commented Jan 29, 2018

Hi @pvdlg
Sorry for the troubles.

I don't think that this:

/**
 * Sentence with a word stating with a
 * Capital letter.
 */

can be fixed easily.

Because any easy fix would not report this:

/**
 * A sentence that is not ended
 * New sentence.
 */

@pvdlg pvdlg deleted the revert-jsdoc branch January 29, 2018 20:04
@pvdlg
Copy link
Contributor Author

pvdlg commented Jan 29, 2018

Let's open issues with eslint-plugin-jsdoc, see what get fixed and re-evaluate later on what rule is stable enough to be used.

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

Successfully merging this pull request may close these issues.

None yet

3 participants