Blocks: Remove require-jsdoc
eslint rule
#251
Merged
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.
Remove
require-jsdoc
from our eslint config. I've been disabling this per-file in #243 & #250, since adding valid jsdoc comments to components (and each method in each component) is more noise than benefit. These are usually overly-generic and the components are just as understandable without them. For example…Sure, ^ this could be "Component to display the organizer list" but that's clear from the code. This doc for
render
is also not helpful, it's the render function in the edit component, of course it'll render editing UI.Since components can be functions, classes, or anonymous functions, I've just removed the rule entirely – we can trust a developer's best judgement for whether a function needs documentation, and the
valid-jsdoc
rule will still kick in to check the formatting.