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

Disable extra property reporting #679

Merged
merged 1 commit into from
Jan 24, 2021

Conversation

brettz9
Copy link
Collaborator

@brettz9 brettz9 commented Jan 22, 2021

Builds on #678. Closes #676.

  • feat(check-param-names): add options disableExtraPropertyReporting to allow extra properties to be documented without error (as long as there are no siblings destructured as for such cases, they will still be expected since the function is not using them)

There may be cases where a project would want to document even these, but they can do so by using a separate typedef, so I'm not sure there's need for an additional boolean to handle that case.

…` to allow extra properties to be documented without error (as long as there are no siblings destructured as for such cases, they will still be expected since the function is not using them)
@brettz9 brettz9 force-pushed the disableExtraPropertyReporting branch from 1d84366 to 0cc1f94 Compare January 24, 2021 13:24
@brettz9 brettz9 merged commit 8b2d143 into gajus:master Jan 24, 2021
@gajus
Copy link
Owner

gajus commented Jan 24, 2021

🎉 This PR is included in version 31.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@brettz9 brettz9 deleted the disableExtraPropertyReporting branch January 24, 2021 14:05
@gajus gajus added the released label Jan 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Why doesn't jsdoc/check-param-names check for property defaults?
2 participants