Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Brett Zamir <[email protected]>
  • Loading branch information
JoshuaKGoldberg and brettz9 authored Aug 12, 2024
1 parent b35fadf commit fe87ace
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 2 deletions.
2 changes: 1 addition & 1 deletion .README/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The general starting rulesets you can extend from in flat config are:

* `jsdoc.configs['flat/recommended']`: Recommended starting rules for enforcing proper tag values, that common tags exist, and that tags are formatted and styled consistently
* `jsdoc.configs['flat/recommended-error']`: The same, reporting with failing errors instead of mere warnings
* `jsdoc.configs['flat/recommended-typescript']`: A similar recommended starting list, adjusted for projects using TypeScript syntax (and not just "typescript" `mode`)
* `jsdoc.configs['flat/recommended-typescript']`: A similar recommended starting list, adjusted for projects using TypeScript syntax (and not just the "typescript" `mode` setting)
* `jsdoc.configs['flat/recommended-typescript-error']`: The same, reporting with failing errors instead of mere warnings
* `jsdoc.configs['flat/recommended-typescript-flavor']`: A similar recommended starting list, adjusted for projects using JavaScript syntax (source files that are still `.js`) but using TypeScript flavor within JSDoc (i.e., the default "typescript" `mode` in `eslint-plugin-jsdoc`)
* `jsdoc.configs['flat/recommended-typescript-flavor-error']`: The same, reporting with failing errors instead of mere warnings
Expand Down
1 change: 0 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,6 @@ const createLogicalTypescriptRuleset = createStandaloneRulesetFactory([
'jsdoc/require-returns-check',
'jsdoc/require-yields-check',
'jsdoc/no-defaults',
'jsdoc/no-multi-asterisks',
'jsdoc/no-types',
'jsdoc/no-undefined-types',
'jsdoc/valid-types',
Expand Down

0 comments on commit fe87ace

Please sign in to comment.