-
-
Notifications
You must be signed in to change notification settings - Fork 153
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
@private shouldn't require anything #78
Comments
Fix welcome. |
More details about what "anything" is would be helpful. All rules should be skipped? There is a particular error for the single parameter which should be skipped? |
@brokentone I would think that all rules should be skipped. |
Sorry, I suppose I'm late on the draw here. I would tend to disagree with this reasoning. jsdocs are not just for public users, they can also be useful internally. I for one would be confused of I lost all validation if I added the That said, were this a desired feature for people, perhaps it's a global setting which gets applied to all rules |
I would say that jsdoc is for public documentation. /**
* @function
* @param {Object} x - awesome object
*/
function getPoint(x) {
const result = ccalulcatePoint(x);
}
// named it dubble cc to avoid monsters
function ccalculatePoint() {} |
I reverted the changes until broader consensus is reached. I agree with @brokentone that:
|
I hit the same issue, but my assumption is that this should be configurable. jsdoc is for public documentation, but In my case, I would prefer not to have to document params when |
If you want me to make a proof of concept I'm open to that. This change as it is also probably breaks a lot of user exceptions of how validation works which is bad. Extra options for other validation to be ignored when |
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
I've started a branch for this (via an optional (off by default) |
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…d code (see requireParam in this commit) to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…is in `requireParam` in this commit to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
…is in `requireParam` in this commit to other rules like requireReturns - `ignorePrivate` setting toward gajus#78
🎉 This issue has been resolved in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
The text was updated successfully, but these errors were encountered: