forked from microsoft/TypeScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Fix all internal JSDoc comments #14
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
Closed
Parent:
Add JSDoc eslint rule
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7bb2d56 to
efaf2d7
Compare
739e71d to
a31b0ef
Compare
efaf2d7 to
9d46c28
Compare
a31b0ef to
223a3f5
Compare
9d46c28 to
2e6b763
Compare
223a3f5 to
9b79d42
Compare
2e6b763 to
0c5afda
Compare
9b79d42 to
72d390c
Compare
0c5afda to
bb1c98d
Compare
72d390c to
ff637c0
Compare
bb1c98d to
b75e466
Compare
ff637c0 to
40f3f72
Compare
b75e466 to
980ee49
Compare
40f3f72 to
d4005a7
Compare
980ee49 to
ee7ee41
Compare
d4005a7 to
c80e914
Compare
ee7ee41 to
8debd97
Compare
c80e914 to
1764185
Compare
8debd97 to
d7091d6
Compare
1764185 to
ebf0539
Compare
d7091d6 to
7d9b69a
Compare
ebf0539 to
22a440a
Compare
7d9b69a to
df9f2b8
Compare
22a440a to
e744bbc
Compare
df9f2b8 to
d6035b0
Compare
e744bbc to
0d8842b
Compare
d6035b0 to
94dedfd
Compare
0d8842b to
99362b4
Compare
4ff5210 to
fb79c58
Compare
1d08a7a to
efb82d0
Compare
fb79c58 to
d611199
Compare
efb82d0 to
67fb332
Compare
d611199 to
f73b5d5
Compare
67fb332 to
af3c30f
Compare
f73b5d5 to
f9a831b
Compare
af3c30f to
763d093
Compare
f9a831b to
55034d7
Compare
763d093 to
f63b759
Compare
55034d7 to
875c9e5
Compare
f63b759 to
8dd2d7a
Compare
875c9e5 to
a976a7b
Compare
8dd2d7a to
75cbb86
Compare
a976a7b to
0034428
Compare
75cbb86 to
80efc34
Compare
0034428 to
bd75883
Compare
80efc34 to
2141f05
Compare
bd75883 to
6549b80
Compare
2141f05 to
86f4fd2
Compare
6549b80 to
48ab28c
Compare
86f4fd2 to
41f98af
Compare
48ab28c to
b71c759
Compare
41f98af to
b718f5a
Compare
b71c759 to
dcef3b9
Compare
If these are regular comments, then they won't appear in our d.ts files. But, now we are relying on an external d.ts bundler to produce our final merged, so they need to be present in the "input" d.ts files, meaning they have to be JSDoc comments. These comments only work today because all of our builds load their TS files from scratch, so they see the actual source files and their non-JSDoc comments. The comments also need to be attached to a declaration, not floating, otherwise they won't be used by api-extractor, so move them if needed.
dcef3b9 to
597e4a7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If these are regular comments, then they won't appear in our d.ts files.
But, now we are relying on an external d.ts bundler to produce our final
merged, so they need to be present in the "input" d.ts files, meaning
they have to be JSDoc comments.
These comments only work today because all of our builds load their TS
files from scratch, so they see the actual source files and their
non-JSDoc comments.
The comments also need to be attached to a declaration, not floating,
otherwise they won't be used by api-extractor, so move them if needed.
Please do not comment on this PR. Depending on how this set of PRs evolves, this PR's contents may change entirely based on the order of commits.
This PR is a part of a stack: