From 99d92bc52d76883a441d87da5bd50fe88cc6849f Mon Sep 17 00:00:00 2001 From: Michael Lehenbauer Date: Fri, 3 Mar 2023 18:02:31 -0800 Subject: [PATCH] Expand / clarify compilerOptions docs. See https://github.com/TypeStrong/typedoc/issues/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. --- guides/options.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/options.md b/guides/options.md index 2c4d0e6d..9828f7cd 100644 --- a/guides/options.md +++ b/guides/options.md @@ -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 {