Skip to content

Commit

Permalink
docs: fix docs for getJsdocProcessorPlugin
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Jul 29, 2024
1 parent 3ba475e commit f0f5e18
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .README/processors.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The approach below works in ESLint 9. For ESLint 7, please see our [`check-examp
The approach requires that we first indicate the JavaScript files that will be checked for `@example` tags.

```js
import getJsdocProcessorPlugin from 'eslint-plugin-jsdoc/getJsdocProcessorPlugin.js';
import {getJsdocProcessorPlugin} from 'eslint-plugin-jsdoc/getJsdocProcessorPlugin.js';

export default [
{
Expand All @@ -28,7 +28,7 @@ export default [
},
processor: 'examples/examples'
},
],
];
```

Now you can target the JavaScript inside these `@example` or default blocks
Expand Down
4 changes: 2 additions & 2 deletions docs/processors.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The approach below works in ESLint 9. For ESLint 7, please see our [`check-examp
The approach requires that we first indicate the JavaScript files that will be checked for `@example` tags.

```js
import getJsdocProcessorPlugin from 'eslint-plugin-jsdoc/getJsdocProcessorPlugin.js';
import {getJsdocProcessorPlugin} from 'eslint-plugin-jsdoc/getJsdocProcessorPlugin.js';

export default [
{
Expand All @@ -30,7 +30,7 @@ export default [
},
processor: 'examples/examples'
},
],
];
```

Now you can target the JavaScript inside these `@example` or default blocks
Expand Down

0 comments on commit f0f5e18

Please sign in to comment.