Skip to content

Commit 4f75d5a

Browse files
Update packages/plugin-typescript/README.md
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
1 parent b238ec4 commit 4f75d5a

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

packages/plugin-typescript/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -98,15 +98,14 @@ await typescriptPlugin({
9898
tsconfig: './tsconfig.json',
9999
});
100100

101-
#### OnlyAudits
101+
#### `onlyAudits`
102102

103-
Optional parameter. The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. Example:
103+
The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. All audits are included by default. Example:
104104

105105
```js
106-
typescriptPlugin({
106+
await typescriptPlugin({
107107
onlyAudits: ['no-implicit-any'],
108108
});
109-
```
110109
111110
### Optionally set up categories
112111

0 commit comments

Comments
 (0)