Skip to content

Commit

Permalink
Expand / clarify compilerOptions docs.
Browse files Browse the repository at this point in the history
See TypeStrong/typedoc#2143 for context.  I found it confusing to be setting TypeScript compiler options on a doc generator. Hopefully my edit will make it a little clearer / help people find appropriate context in the context.  Feel free to reject if you're not a fan. No biggie.
  • Loading branch information
mikelehen committed Mar 4, 2023
1 parent c61b5fb commit 99d92bc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions guides/options.md
Expand Up @@ -112,8 +112,8 @@ TypeDoc provides its default configuration for extension in `typedoc/tsdoc.json`

### compilerOptions

Used to selectively override compiler options for generating documentation. Values set with this option
will override options read from `tsconfig.json`.
Used to selectively override compiler options for generating documentation. TypeDoc parses code using the TypeScript compiler and will therefore behave similarly to tsc. Values set with this option
will override options read from `tsconfig.json`. See [#1891](https://github.com/TypeStrong/typedoc/pull/1891) for details.

```json
{
Expand Down

0 comments on commit 99d92bc

Please sign in to comment.