only require JSDoc returns when public #265
Open
Conversation
This file contains 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
Trying this out to see whether it seems to be a good idea or not. Related option: https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#options Related PR: gajus/eslint-plugin-jsdoc#1156 Related issue: gajus/eslint-plugin-jsdoc#1137
voxpelli
force-pushed
the
use-jsdoc-ts-flavor-recommendation
branch
2 times, most recently
from
34617b3
to
5c2398b
Compare
voxpelli
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Compliance Checks
Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.
Conventional Commit PR Title
In order to be considered for merging, the pull request title must match the specification in conventional commits. You can edit the title in order for this check to pass.
Most often, our PR titles are something like one of these:
- docs: correct typo in README
- feat: implement dark mode"
- fix: correct remove button behavior
Linting Errors
- Found type "null", must be one of "feat","fix","docs","style","refactor","perf","test","build","ci","chore","revert"
- No subject found
voxpelli
force-pushed
the
use-jsdoc-ts-flavor-recommendation
branch
from
5c2398b
to
d94c210
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Trying this out to see whether it seems to be a good idea or not.
require-returns): addpublicOnlyoption gajus/eslint-plugin-jsdoc#1156require-returnsonly on exported functions gajus/eslint-plugin-jsdoc#1137