Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

requireHyphenBeforeDescription should not apply to descriptions on next line #1579

Closed
JamesMessinger opened this issue Jul 28, 2015 · 3 comments
Assignees
Labels

Comments

@JamesMessinger
Copy link

The new requireHyphenBeforeDescription option is great, but it should only apply to inline descriptions. If a description is on the next line (usually because it's a long one), then no hyphen should be required.

Example:

/**
 * This function does foo to bar.
 *
 * @param {string} bar
 * This is a really long description of the "bar" parameter.  In fact, the description
 * is so long that it spans multiple lines.
 */
function foo(bar) {

Currently, in order to make this check pass, I have to add a hyphen, like this (which looks weird):

/**
 * This function does foo to bar.
 *
 * @param {string} bar
 * - This is a really long description of the "bar" parameter.  In fact, the description
 * is so long that it spans multiple lines.
 */
function foo(bar) {
@qfox
Copy link
Member

qfox commented Aug 2, 2015

Thanks for report, it's not really for jscs, but for jscs-jsdoc. Going to fix that. ;-)

@markelog
Copy link
Member

markelog commented Aug 2, 2015

@zxqfox don't forget to update jscs-doc dep

@qfox
Copy link
Member

qfox commented Aug 2, 2015

@markelog Yeah, sure. Will try to work on #1531

jdlrobson pushed a commit to jdlrobson/jscs-jsdoc that referenced this issue Aug 21, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

4 participants