Skip to content

Commit ed757c2

Browse files
authored
[api-extractor] Update some comments in api-extractor-template.json (#4849)
* Fix some minor issues encountered while syncing up microsoft/rushstack-websites#262 * rush change
1 parent 1a92f17 commit ed757c2

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

apps/api-extractor/src/schemas/api-extractor-template.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,9 @@
182182
* prepend a folder token such as "<projectFolder>".
183183
*
184184
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
185-
* DEFAULT VALUE: "<projectFolder>/temp/"
185+
* DEFAULT VALUE: "<projectFolder>/etc/"
186186
*/
187-
// "reportFolder": "<projectFolder>/temp/",
187+
// "reportFolder": "<projectFolder>/etc/",
188188

189189
/**
190190
* Specifies the folder where the temporary report file is written. The file name portion is determined by
@@ -249,7 +249,7 @@
249249
* item's file path is "api/ExtractorConfig.ts", the full URL file path would be
250250
* "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js".
251251
*
252-
* Can be omitted if you don't need source code links in your API documentation reference.
252+
* This setting can be omitted if you don't need source code links in your API documentation reference.
253253
*
254254
* SUPPORTED TOKENS: none
255255
* DEFAULT VALUE: ""
@@ -284,6 +284,8 @@
284284
* Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release.
285285
* This file will include only declarations that are marked as "@public", "@beta", or "@alpha".
286286
*
287+
* If the path is an empty string, then this file will not be written.
288+
*
287289
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
288290
* prepend a folder token such as "<projectFolder>".
289291
*
@@ -296,6 +298,8 @@
296298
* Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
297299
* This file will include only declarations that are marked as "@public" or "@beta".
298300
*
301+
* If the path is an empty string, then this file will not be written.
302+
*
299303
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
300304
* prepend a folder token such as "<projectFolder>".
301305
*
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@microsoft/api-extractor",
5+
"comment": "",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@microsoft/api-extractor"
10+
}

0 commit comments

Comments
 (0)