docs: fix various typos (#167)

john-u · web-flow · commit 5085bd554d72 · 2020-10-12T11:16:25.000-05:00
diff --git a/docs/classes/_pages_decimal_setting_d_.decimalsetting.md b/docs/classes/_pages_decimal_setting_d_.decimalsetting.md
@@ -116,7 +116,7 @@ ___
 
 ▸ **min**(`value`: number): *[DecimalSetting](_pages_decimal_setting_d_.decimalsetting.md)*
 
-The minumum inclusive value the decimal can be set to.
+The minimum inclusive value the decimal can be set to.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_enum_setting_d_.enumsetting.md b/docs/classes/_pages_enum_setting_d_.enumsetting.md
@@ -31,7 +31,7 @@ A drawback of specifying the options as a map, however, is that the order of the
 necessarily be controlled. To specify options in a controlled order you can specify them as a list of id/name
 OptionItems:
 ```
-section.enumSetting('opjectListEnum')
+section.enumSetting('objectListEnum')
     .translateOptions(false)
     .options([
         {id: 25, name: '25 %'},
@@ -180,7 +180,7 @@ ___
 
 ▸ **i18nOptionGroupOptionKey**(`groupName`: string, `optionItemName`: string): *string*
 
-REturnes the localization property file key for the specified grouped option property
+Returns the localization property file key for the specified grouped option property
 
 **Parameters:**
 
@@ -342,7 +342,7 @@ ___
 
 ▸ **translateOptions**(`value`: boolean): *[EnumSetting](_pages_enum_setting_d_.enumsetting.md)*
 
-Dtermines whether options are translated, which developers may want to disable if the labels are
+Determines whether options are translated, which developers may want to disable if the labels are
 values generated by the app and already in the language of the user.
 
 **Parameters:**
diff --git a/docs/classes/_pages_number_setting_d_.numbersetting.md b/docs/classes/_pages_number_setting_d_.numbersetting.md
@@ -124,7 +124,7 @@ ___
 
 ▸ **min**(`value`: number): *[NumberSetting](_pages_number_setting_d_.numbersetting.md)*
 
-The minumum inclusive value the decimal can be set to.
+The minimum inclusive value the decimal can be set to.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_page_d_.page.md b/docs/classes/_pages_page_d_.page.md
@@ -70,7 +70,7 @@ ___
 
 ▸ **nextPageId**(`value`: string): *[Page](_pages_page_d_.page.md)*
 
-Sets the next page in a mult-page app configuration
+Sets the next page in a multi-page app configuration
 
 **Parameters:**
 
@@ -147,7 +147,7 @@ ___
 
 ▸ **style**(`value`: [PageStyle](../enums/_pages_page_d_.pagestyle.md)): *[Page](_pages_page_d_.page.md)*
 
-Set the stylee of this page
+Set the style of this page
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_section_d_.section.md b/docs/classes/_pages_section_d_.section.md
@@ -1,15 +1,15 @@
 [Reference](../index.md) › [SmartApp](_smart_app_d_.smartapp.md) › [Page](_pages_page_d_.page.md) › [Section](_pages_section_d_.section.md)
 # Section
 
-A section is a labeled collection of settings. The contents can be made collapsable if desired.
-To create a basic non-collapsable section:
+A section is a labeled collection of settings. The contents can be made collapsible if desired.
+To create a basic non-collapsible section:
 ```
 page.section('section1', section => {
     // create settings here, e.g
     section.booleanSetting('turnBackOn')
 }
 ```
-To make this section collapsable (and initially collapsed):
+To make this section collapsible (and initially collapsed):
 ```
 page.section('section1', section => {
     section.hideable(true).hidden(true)
diff --git a/docs/classes/_pages_time_setting_d_.timesetting.md b/docs/classes/_pages_time_setting_d_.timesetting.md
@@ -117,7 +117,7 @@ ___
 
 ▸ **min**(`value`: string): *[TimeSetting](_pages_time_setting_d_.timesetting.md)*
 
-The earlies time that can be entered
+The earliest time that can be entered
 
 **Parameters:**
 
diff --git a/docs/classes/_smart_app_d_.smartapp.md b/docs/classes/_smart_app_d_.smartapp.md
@@ -215,7 +215,7 @@ ___
 
 Defines a handler to be called for any device command event that does not have a handler
 defined for that specific command. The default implementation of this handler simply logs a
-message about the missing command handler. Note that only C2C connector smartapps that create
+message about the missing command handler. Note that only C2C connector SmartApps that create
 devices will receive command events.
 
 **Parameters:**
diff --git a/docs/interfaces/_util_smart_app_context_d_.smartappcontext.md b/docs/interfaces/_util_smart_app_context_d_.smartappcontext.md
@@ -173,7 +173,7 @@ Tests whether the context is authenticated to make API calls, i.e. has an access
 Note that this method does not actually test the validity of the token, but rather
 whether it is present or not. Contexts of CONFIGURATION lifecycle events are not
 authenticated. Therefore if an app needs to make API calls during the configuration
-lifecycle it must use a token store to authenicate itself.
+lifecycle it must use a token store to authenticate itself.
 
 **Returns:** *boolean*
 
diff --git a/lib/lifecycle-events.d.ts b/lib/lifecycle-events.d.ts
@@ -83,7 +83,7 @@ export namespace AppEvent {
          */
         'value': any;
         /**
-         * The root level data type of the value field. The data types are representitive of standard JSON data types.
+         * The root level data type of the value field. The data types are representative of standard JSON data types.
          */
         'valueType': string;
         /**
@@ -459,7 +459,7 @@ export namespace AppEvent {
          */
         'installedAppId': string;
         /**
-         * A relative URL containing all of the query string parameters as returned by the third party oauth system. A SmartApp can parse the `urlPath` property to extract any senstive auth codes/tokens which can then be used to access the third party system.
+         * A relative URL containing all of the query string parameters as returned by the third party oauth system. A SmartApp can parse the `urlPath` property to extract any sensitive auth codes/tokens which can then be used to access the third party system.
          */
         'urlPath': string;
     }
@@ -490,7 +490,7 @@ export namespace AppEvent {
          */
         'appId': string;
         /**
-         * An HTTPS url that may be visted to confirm / activate an App registration.
+         * An HTTPS url that may be visited to confirm / activate an App registration.
          */
         'confirmationUrl': string;
     }
diff --git a/lib/pages/decimal-setting.d.ts b/lib/pages/decimal-setting.d.ts
@@ -20,7 +20,7 @@ export class DecimalSetting extends SectionSetting<DecimalSetting> {
     max(value: number): DecimalSetting
 
     /**
-     * The minumum inclusive value the decimal can be set to.
+     * The minimum inclusive value the decimal can be set to.
      */
     min(value: number): DecimalSetting
 
diff --git a/lib/pages/enum-setting.d.ts b/lib/pages/enum-setting.d.ts
@@ -50,7 +50,7 @@ export enum OptionsStyle {
  * necessarily be controlled. To specify options in a controlled order you can specify them as a list of id/name
  * OptionItems:
  * ```
- * section.enumSetting('opjectListEnum')
+ * section.enumSetting('objectListEnum')
  *     .translateOptions(false)
  *     .options([
  *         {id: 25, name: '25 %'},
@@ -102,7 +102,7 @@ export class EnumSetting extends SectionSetting<EnumSetting> {
     style(value: OptionsStyle): EnumSetting
 
     /**
-     * Dtermines whether options are translated, which developers may want to disable if the labels are
+     * Determines whether options are translated, which developers may want to disable if the labels are
      * values generated by the app and already in the language of the user.
      */
     translateOptions(value: boolean): EnumSetting
@@ -113,7 +113,7 @@ export class EnumSetting extends SectionSetting<EnumSetting> {
     i18nOptionGroupKey(groupName: string): string
 
     /**
-     * REturnes the localization property file key for the specified grouped option property
+     * Returns the localization property file key for the specified grouped option property
      * @param groupName the OptionsGroup name
      * @param optionItemName the OptionItem name
      */
diff --git a/lib/pages/number-setting.d.ts b/lib/pages/number-setting.d.ts
@@ -36,7 +36,7 @@ export class NumberSetting extends SectionSetting<NumberSetting> {
     max(value: number): NumberSetting
 
     /**
-     * The minumum inclusive value the decimal can be set to.
+     * The minimum inclusive value the decimal can be set to.
      */
     min(value: number): NumberSetting
 
diff --git a/lib/pages/page-setting.d.ts b/lib/pages/page-setting.d.ts
@@ -1,6 +1,5 @@
 import {Section} from './section'
 import {SectionSetting} from './section-setting'
-import {PageStyle} from './page'
 
 export enum PageLinkStyle {
     COMPLETE ='COMPLETE',
diff --git a/lib/pages/page.d.ts b/lib/pages/page.d.ts
@@ -29,7 +29,7 @@ export class Page {
     name(value: string): Page
 
     /**
-     * Sets the next page in a mult-page app configuration
+     * Sets the next page in a multi-page app configuration
      */
     nextPageId(value: string): Page
 
@@ -54,7 +54,7 @@ export class Page {
     section(name: string, closure: (section: Section) => void | Promise<void>): Page
 
     /**
-     * Set the stylee of this page
+     * Set the style of this page
      */
     style(value: PageStyle): Page
 
diff --git a/lib/pages/section.d.ts b/lib/pages/section.d.ts
@@ -30,15 +30,15 @@ export enum SectionStyle {
 }
 
 /**
- * A section is a labeled collection of settings. The contents can be made collapsable if desired.
- * To create a basic non-collapsable section:
+ * A section is a labeled collection of settings. The contents can be made collapsible if desired.
+ * To create a basic non-collapsible section:
  * ```
  * page.section('section1', section => {
  *     // create settings here, e.g
  *     section.booleanSetting('turnBackOn')
  * }
  * ```
- * To make this section collapsable (and initially collapsed):
+ * To make this section collapsible (and initially collapsed):
  * ```
  * page.section('section1', section => {
  *     section.hideable(true).hidden(true)
diff --git a/lib/pages/time-setting.d.ts b/lib/pages/time-setting.d.ts
@@ -28,7 +28,7 @@ export class TimeSetting extends SectionSetting<TimeSetting> {
     max(value: string): TimeSetting
 
     /**
-     * The earlies time that can be entered
+     * The earliest time that can be entered
      */
     min(value: string): TimeSetting
 }
diff --git a/lib/smart-app.d.ts b/lib/smart-app.d.ts
@@ -164,15 +164,15 @@ export interface ContextStore {
 }
 
 /**
- * Request object for WEBHHOOK_SMART_APPs
+ * Request object for WEBHOOK_SMART_APPs
  */
 export interface WebHookRequest {
     headers: IncomingHttpHeaders
     body: any
 }
 
 /**
- * Response object for WEBHHOOK_SMART_APPs
+ * Response object for WEBHOOK_SMART_APPs
  */
 export interface WebHookResponse {
     status(code: number): WebHookResponse
@@ -277,7 +277,7 @@ export class SmartApp {
     /**
      * Defines a handler to be called for any device command event that does not have a handler
      * defined for that specific command. The default implementation of this handler simply logs a
-     * message about the missing command handler. Note that only C2C connector smartapps that create
+     * message about the missing command handler. Note that only C2C connector SmartApps that create
      * devices will receive command events.
      */
     defaultDeviceCommandHandler(
diff --git a/lib/util/smart-app-context.d.ts b/lib/util/smart-app-context.d.ts
@@ -79,7 +79,7 @@ export interface SmartAppContext {
      * Note that this method does not actually test the validity of the token, but rather
      * whether it is present or not. Contexts of CONFIGURATION lifecycle events are not
      * authenticated. Therefore if an app needs to make API calls during the configuration
-     * lifecycle it must use a token store to authenicate itself.
+     * lifecycle it must use a token store to authenticate itself.
      */
     isAuthenticated(): boolean
 
