Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

If node_modules is excluded by default, it should not be part of a confusing documentation example #30632

Open
ritmos opened this issue Mar 28, 2019 · 0 comments
Labels
Docs The issue relates to how you learn TypeScript

Comments

@ritmos
Copy link

ritmos commented Mar 28, 2019

Hi,
This is not a code issue but documentation that leads to confusion. By default node_modules folder is excluded for tsc. This is good (I guess), but the following documentation https://www.typescriptlang.org/docs/handbook/tsconfig-json.html has an example using node_modules as a folder to exclude. Personally I think this example was very badly picked because it leads to think that you need to exclude "node_modules" explicitly (which I was doind in all my projects for that reason). You need to read the full document to notice that. It is confusing.

PS: This led to confusion as you can see in other typescript project (TypeStrong/ts-loader#278)

Thanks for the great typescript thing by the way!

@RyanCavanaugh RyanCavanaugh added the Docs The issue relates to how you learn TypeScript label Apr 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs The issue relates to how you learn TypeScript
Projects
None yet
Development

No branches or pull requests

2 participants