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

Suggestion: Improve documentation for compiler options #30399

Closed
alexmiddeleer opened this issue Mar 14, 2019 · 1 comment
Closed

Suggestion: Improve documentation for compiler options #30399

alexmiddeleer opened this issue Mar 14, 2019 · 1 comment
Labels
Docs The issue relates to how you learn TypeScript

Comments

@alexmiddeleer
Copy link

alexmiddeleer commented Mar 14, 2019

Background: the point of this suggestion is to reduce the learning curve for users who are very new to typescript (e.g. me). I am learning typescript and Angular together, and it seemed like a good idea to read the default angular tsconfig file (generated by angular new foo) to gain a better understanding of the build process.

The documentation for compiler options may be sufficient for users that are already familiar with typescript concepts, but in my opinion assumes too much prior knowledge for beginners. For several of the options (i.e. "lib" and "typeRoots"), the explanation was confusing.

The quick solution is to add a "prior knowledge assumed" disclaimer at the top of the compiler options page. Additional links and brief summaries in the description column would be even better.

@RyanCavanaugh RyanCavanaugh added the Docs The issue relates to how you learn TypeScript label Mar 14, 2019
@RyanCavanaugh
Copy link
Member

On second read, this wasn't very actionable, and doesn't really match other feedback we've gotten

@RyanCavanaugh RyanCavanaugh closed this as not planned Won't fix, can't repro, duplicate, stale Mar 15, 2024
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