Skip to content

escape param/tag names before check#57

Closed
tunnckoCore wants to merge 1 commit intojscs-dev:masterfrom
tunnckoCore:feature/escape-param-names
Closed

escape param/tag names before check#57
tunnckoCore wants to merge 1 commit intojscs-dev:masterfrom
tunnckoCore:feature/escape-param-names

Conversation

@tunnckoCore
Copy link
Copy Markdown

about #56 to allow

/**
 * would not report
 *
 * @param {String} `ticks`
 * @param {String} `<requiredTicks>`
 * @param {Object} `[optional]`
 * @param {Number} `[n="u m"]` some description here
 */
function methodThree(ticks, requiredTicks, optional, num) {}

@qfox
Copy link
Copy Markdown
Member

qfox commented Nov 26, 2014

I still think it should be optional. Like:

{
  "checkParamNames": "quircks"
}

And it needs tests and readme update.

And... I'm sure this shouldn't be valid ;-)

/**
 * @param {Number} `[n="u m"]` some description here
 */
function methodThree(num) {}

@tunnckoCore
Copy link
Copy Markdown
Author

If we stick to this

And... I'm sure this shouldn't be valid ;-)

it will add more complexity than simple regex.

@qfox
Copy link
Copy Markdown
Member

qfox commented Nov 26, 2014

@tunnckoCore Yeah, sure. But I'm almost did it. Thanks for interesting in this ;-)

@tunnckoCore
Copy link
Copy Markdown
Author

But I'm almost did it.

Cool!

@qfox qfox closed this Nov 26, 2014
jdlrobson pushed a commit to jdlrobson/jscs-jsdoc that referenced this pull request Aug 21, 2015
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.

2 participants