Require documentation for exported variables#437
Draft
mcmire wants to merge 1 commit intoloosen-jsdoc-rulesfrom
Draft
Require documentation for exported variables#437mcmire wants to merge 1 commit intoloosen-jsdoc-rulesfrom
mcmire wants to merge 1 commit intoloosen-jsdoc-rulesfrom
Conversation
It's common in various repos to define a function or constant value,
assign it to a variable, and export it in one go:
```typescript
export const POLLING_INTERVAL = 30 * 1000;
export const Banner = () => {
return (
<div>
{/* ... */}
</div>
)
};
```
Exporting these variables signifies they are important in some way, and
so we want them to be documented for other engineers.
While the second case is already covered by a selector added in a
previous commit, the first case is not. This commit corrects that.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
It's common in various repos to define a function or constant value, assign it to a variable, and export it in one go:
Exporting these variables signifies they are important in some way, and so we want them to be documented for other engineers.
While the second case is already covered by a selector added in a previous commit, the first case is not. This commit corrects that.