Update some docs

octogonz · octogonz · commit fdd3f50a6011 · 2019-04-11T14:29:51.000-07:00
diff --git a/apps/api-extractor/src/api/IConfigFile.ts b/apps/api-extractor/src/api/IConfigFile.ts
@@ -24,7 +24,7 @@ export interface IConfigCompiler {
   tsconfigFilePath?: string;
 
   /**
-   * Provides already parsed tsconfig.json contents.
+   * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
    *
    * @remarks
    * The value must conform to the TypeScript tsconfig schema:
@@ -107,7 +107,7 @@ export interface IConfigApiReport {
  */
 export interface IConfigDocModel {
   /**
-   * Whether to generate doc model file.
+   * Whether to generate a doc model file.
    */
   enabled: boolean;
 
diff --git a/apps/api-extractor/src/schemas/api-extractor-template.json b/apps/api-extractor/src/schemas/api-extractor-template.json
@@ -32,7 +32,7 @@
    * SUPPORTED TOKENS: <lookup>
    * DEFAULT VALUE: "<lookup>"
    */
-  // "projectFolder": "",
+  // "projectFolder": "..",
 
   /**
    * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
@@ -65,7 +65,7 @@
     // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
 
     /**
-     * Provides compiler configuration that will be used instead of reading the tsconfig.json file from disk.
+     * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
      * The object must conform to the TypeScript tsconfig schema:
      *
      * http://json.schemastore.org/tsconfig
@@ -145,7 +145,7 @@
    */
   "docModel": {
     /**
-     * (REQUIRED) Whether to generate doc model file.
+     * (REQUIRED) Whether to generate a doc model file.
      */
     "enabled": true,
 
diff --git a/apps/api-extractor/src/schemas/api-extractor.schema.json b/apps/api-extractor/src/schemas/api-extractor.schema.json
@@ -28,11 +28,11 @@
       "type": "object",
       "properties": {
         "tsconfigFilePath": {
-          "description": " Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.  The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as \"<projectFolder>\".  Note: This setting will be ignored if \"overrideTsconfig\" is used.",
+          "description": "Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.  The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as \"<projectFolder>\".  Note: This setting will be ignored if \"overrideTsconfig\" is used.",
           "type": "string"
         },
         "overrideTsconfig": {
-          "description": "Provides already parsed tsconfig.json contents conforming to the TypeScript tsconfig schema: http://json.schemastore.org/tsconfig If omitted, then the tsconfig.json file will be read from the \"projectFolder\".",
+          "description": "Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. The object must conform to the TypeScript tsconfig schema: http://json.schemastore.org/tsconfig  If omitted, then the tsconfig.json file will be read from the \"projectFolder\".",
           "type": "object"
         },
         "skipLibCheck": {
