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

9136 require returns #9137

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

9136 require returns #9137

wants to merge 2 commits into from

Conversation

turadg
Copy link
Member

@turadg turadg commented Mar 25, 2024

refs: #9136

Description

Spike on,

We might want to exempt contracts. We could do that by ignoring .contract.js files (and using that extension for contracts). Another option is to have a tag like @contract and add it to the rule's ignore list. Either way, we'll lose the documentation of the start function in the .d.ts. A counter to that is that documentation of the contract should be at the module level in @file.

For Exo, I don't know whether we'd want to exempt because they're more likely to need the JSDoc comments. We could specify the return type by getting it from the interface definitions. But that would require something like #6160

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

Comment on lines +63 to +66
'jsdoc/require-returns': [
'error',
{ exemptedBy: ['type'], publicOnly: true },
],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

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