Add docs to types

words · Nov 6, 2022 · fd9b253 · fd9b253
1 parent 31f7a40
commit fd9b253
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/build.js b/build.js
@@ -5,5 +5,7 @@ const doc = fs.readFileSync('data.txt', 'utf8')
 
 fs.writeFileSync(
   'index.js',
-  'export const hedges = ' + JSON.stringify(toJson(doc), null, 2) + '\n'
+  '/**\n * List of *supposed* English (both British and American) hedge words.\n */\nexport const hedges = ' +
+    JSON.stringify(toJson(doc), null, 2) +
+    '\n'
 )
diff --git a/index.js b/index.js
@@ -1,3 +1,6 @@
+/**
+ * List of *supposed* English (both British and American) hedge words.
+ */
 export const hedges = [
   'a bit',
   'about',