Use explicit file types for module examples #3052
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In "The
module
compiler option" section of the TS docs, it is difficult to understand that each pair of codeblocks represents a source file and built file. It is obvious in the markdown code due to the fact that the language is specified in the code block, but that is not transparent to the reader of the site. For example, theES...
example section has an identical input and output which is confusing for most even given the context of the section it is in or even the page they are on.This PR attempts to fix that by adding filename comments above each pair of code blocks that specify that it is an input file (
.ts
) or a built file (.js
). The syntax chosen matches the syntax from the "Type-only imports and exports" section on the same page.As an example, here is the existing
ES...
section.