Skip to content

Commit 6688285

Browse files
committed
Comment update
1 parent 6355e11 commit 6688285

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

tasks/clean-references.mjs

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
import { writeFileSync, readFileSync } from 'fs';
22
import { packageCategories } from '../src/data/api-categories.mjs';
33
import { processReferences } from '../src/data/process-typedoc.mjs';
4+
45
/**
5-
* The purpose of this script is to create generate an object that only contains
6-
* the desired category nodes and every node needed to generate the api documentation
7-
* for these nodes. This is done by iterating over the needed category nodes and
8-
* then recursively adding every node found into cleanReferences.
6+
* Read the -p flag from the cli params
7+
*
8+
* This flag tells is which package is adjacent with a references file to read from
9+
* eg. `-p amplify-js` means that `../amplify-js/docs/reference.json` exists and is
10+
* ready to be transformed into `src/directory/apiReferences/amplify-js.json`
911
*/
10-
// Read the -p flag from the cli params
11-
console.log(JSON.stringify(process.argv));
12-
1312
const packageIndex = process.argv.indexOf('-p');
1413

1514
if (packageIndex === -1) {

0 commit comments

Comments
 (0)