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

module.exports and @name #7

Open
tunnckoCore opened this issue Sep 29, 2015 · 2 comments
Open

module.exports and @name #7

tunnckoCore opened this issue Sep 29, 2015 · 2 comments
Labels

Comments

@tunnckoCore
Copy link

I'm not sure if the issue is for here, but yea... maybe you know better, i dont have time to investigate deeper and just want to mention it

Currently, using some tools like helper-apidocs or the cli apidocs-cli and the following example

/**
 * > Lorem ipsum thingish thing
 *
 * @param  {Number} `one` you should pass `1`
 * @param  {Number} `two` you should pass `2`
 * @return {Number} the `one + two` result
 * @api public
 */
module.exports = function foobar (one, two) {
  return one + two
}

will output

### [.exports](./index.js#L10)

* `one` **{Number}**: you should pass `1`    
* `two` **{Number}**: you should pass `2`    
* `returns` **{Number}**: the `one + two` result  

> Lorem ipsum thingish thing

notice the [.exports], so we need to be [foobar] without adding the @name foobar.
And notice the #L10 for which i'm talking in #6.

I can guarantee that these things isn't from my side (from my packages and etc)

@jonschlinkert
Copy link
Owner

yeah it's a bug. honestly this just needs to be refactored completely. I already started, should be done soon

@tunnckoCore
Copy link
Author

honestly this just needs to be refactored completely.

haha, yea.

should be done soon

Great to hear.

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

No branches or pull requests

2 participants