Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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