docs: deprecate color setting and fix typos (#203)

john-u · web-flow · commit 9812eaa618e8 · 2021-08-09T13:16:58.000-05:00
diff --git a/docs/classes/_pages_color_setting_d_.colorsetting.md b/docs/classes/_pages_color_setting_d_.colorsetting.md
@@ -2,7 +2,7 @@
 
 # ColorSetting
 
-NOT IMPLEMENTED
+**`deprecated`** Not currently implemented
 
 ## Methods
 
diff --git a/docs/classes/_pages_email_setting_d_.emailsetting.md b/docs/classes/_pages_email_setting_d_.emailsetting.md
@@ -2,7 +2,7 @@
 
 # EmailSetting
 
-An email setting creates an input box with a keyboard appropriate for the entry of email addresses
+An email setting creates an input box with a keyboard appropriate for the entry of email addresses.
 ```
 section.emailSetting("emailAddress")
 ```
diff --git a/docs/classes/_pages_enum_setting_d_.enumsetting.md b/docs/classes/_pages_enum_setting_d_.enumsetting.md
@@ -47,7 +47,7 @@ section.enumSetting('groupedEnum')
             {id:'red', name:'Red'},
             {id:'yellow', name:'Yellow'},
             {id:'blue', name:'Blue'}]},
-        {name: 'primaryColors', options: [
+        {name: 'secondaryColors', options: [
             {id:'green', name:'Green'},
             {id:'orange', name:'Orange'},
             {id:'purple', name:'Purple'}]},
@@ -213,7 +213,7 @@ ___
 
 ▸ **multiple**(`value`: boolean): *[EnumSetting](_pages_enum_setting_d_.enumsetting.md)*
 
-Specifies whether this device setting can have multiple values.
+Specifies whether this enum setting can have multiple values.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_image_setting_d_.imagesetting.md b/docs/classes/_pages_image_setting_d_.imagesetting.md
@@ -2,7 +2,7 @@
 
 # ImageSetting
 
-An image settings simply displays an image on the configuration page. There is no user input involved.
+An image setting simply displays an image on the configuration page. There is no user input involved.
 ```
 section.imageSetting('banner')
     .image('https://mysite/image.png')
diff --git a/docs/classes/_pages_images_setting_d_.imagessetting.md b/docs/classes/_pages_images_setting_d_.imagessetting.md
@@ -2,7 +2,7 @@
 
 # ImagesSetting
 
-An images settings displays a carousel of images on the configuration page. There is no user input involved.
+An images setting displays a carousel of images on the configuration page. There is no user input involved.
 ```
 section.imageSetting('banner')
     .images(['https://mysite/image.png', 'https://mysite/image2.png', 'https://mysite/image3.png')
diff --git a/docs/classes/_pages_link_setting_d_.linksetting.md b/docs/classes/_pages_link_setting_d_.linksetting.md
@@ -2,7 +2,7 @@
 
 # LinkSetting
 
-A link setting display a hypertext link that opens an external web page in a browser window. It
+A link setting displays a hypertext link that opens an external web page in a browser window. It
 does not replace the current configuration page window.
 ```
 section.linkSetting('moreInfo')
diff --git a/docs/classes/_pages_mode_setting_d_.modesetting.md b/docs/classes/_pages_mode_setting_d_.modesetting.md
@@ -2,12 +2,12 @@
 
 # ModeSetting
 
-A device setting creates a control that allows the user to select one or more location modes. To allow the selection
+A mode setting creates a control that allows the user to select one or more location modes. To allow the selection
 of only one mode:
 ```
 section.modeSetting('targetMode')
 ```
-The allow the selection of more than one mode:
+To allow the selection of more than one mode:
 ```
 section.modeSetting('permittedModes').multiple(true)
 ```
@@ -100,7 +100,7 @@ ___
 
 ▸ **multiple**(`boolean`: true): *[ModeSetting](_pages_mode_setting_d_.modesetting.md)*
 
-Specifies whether this device setting can have multiple values.
+Specifies whether this mode setting can have multiple values.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_page_d_.page.md b/docs/classes/_pages_page_d_.page.md
@@ -86,7 +86,7 @@ ___
 
 ▸ **nextText**(`value`: string): *[Page](_pages_page_d_.page.md)*
 
-Set the text of the next page link. Defaults to "Next"
+Set the text of the next page link (defaults to "Next"). Only applies if style is `SPLASH`
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_page_setting_d_.pagesetting.md b/docs/classes/_pages_page_setting_d_.pagesetting.md
@@ -2,7 +2,7 @@
 
 # PageSetting
 
-A page setting create a link to another configuration page. Tapping on the link displays
+A page setting creates a link to another configuration page. Tapping on the link displays
 the linked page.
 
 ## Methods
diff --git a/docs/classes/_pages_scene_setting_d_.scenesetting.md b/docs/classes/_pages_scene_setting_d_.scenesetting.md
@@ -2,7 +2,7 @@
 
 # SceneSetting
 
-A scene setting display a control that allows one or more scenes to be selected.
+A scene setting displays a control that allows one or more scenes to be selected.
 ```
 section.sceneSetting('selectedScene')
 ```
@@ -95,7 +95,7 @@ ___
 
 ▸ **multiple**(`value`: true): *[SceneSetting](_pages_scene_setting_d_.scenesetting.md)*
 
-Specifies whether this device setting can have multiple values.
+Specifies whether this scene setting can have multiple values.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_security_setting_d_.securitysetting.md b/docs/classes/_pages_security_setting_d_.securitysetting.md
@@ -92,7 +92,7 @@ ___
 
 ▸ **multiple**(`value`: boolean): *[SecuritySetting](_pages_security_setting_d_.securitysetting.md)*
 
-Specifies whether this device setting can have multiple values.
+Specifies whether this security setting can have multiple values.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_sound_setting_d_.soundsetting.md b/docs/classes/_pages_sound_setting_d_.soundsetting.md
@@ -91,7 +91,7 @@ ___
 
 ▸ **multiple**(`value`: boolean): *[SoundSetting](_pages_sound_setting_d_.soundsetting.md)*
 
-Specifies whether this device setting can have multiple values.
+Specifies whether this sound setting can have multiple values.
 
 **Parameters:**
 
diff --git a/docs/classes/_pages_text_setting_d_.textsetting.md b/docs/classes/_pages_text_setting_d_.textsetting.md
@@ -2,7 +2,7 @@
 
 # TextSetting
 
-A text setting create a text input field with full alphanumeric keypad.
+A text setting creates a text input field with full alphanumeric keypad.
 ```
 section.textSetting('warningMessage')
 ```
diff --git a/docs/classes/_pages_video_setting_d_.videosetting.md b/docs/classes/_pages_video_setting_d_.videosetting.md
@@ -2,11 +2,11 @@
 
 # VideoSetting
 
-An image settings simply displays an image on the configuration page. There is no user input involved.
+A video setting provides a player on the configuration page allowing the user to play/pause a video.
 ```
 section.videoSetting('instructions')
     .image('https://mysite/preview.png')
-    .video('https…//mysite/video.mp4')
+    .video('https://mysite/video.mp4')
 ```
 
 ## Methods
@@ -80,7 +80,8 @@ ___
 
 ▸ **image**(`source`: string): *[VideoSetting](_pages_video_setting_d_.videosetting.md)*
 
-Set the URL of an image to display as a preview of the video
+Set the URL of an image to display as a video thumbnail.
+Max length 2048 characters.
 
 **Parameters:**
 
@@ -177,7 +178,8 @@ ___
 
 ▸ **video**(`source`: string): *[VideoSetting](_pages_video_setting_d_.videosetting.md)*
 
-Set the URL of the video
+Set the URL of the video.
+Max length 2048 characters.
 
 **Parameters:**
 
diff --git a/docs/classes/_smart_app_d_.smartapp.md b/docs/classes/_smart_app_d_.smartapp.md
@@ -510,8 +510,7 @@ ___
 
 ▸ **initialized**(`callback`: function): *[SmartApp](_smart_app_d_.smartapp.md)*
 
-Defines a handler to be called before configuration the first time a SmartApp is installed. If not specified then the
-`updated()` handler will be called on the initial installation as well as updates.
+Defines a handler to be called before configuration the first time a SmartApp is installed.
 
 **Parameters:**
 
diff --git a/lib/i18n.d.ts b/lib/i18n.d.ts
@@ -52,7 +52,7 @@ export namespace i18n {
 
 		/**
 		 * Whether to write new locale information to disk
-		 * @default true
+		 * @default false
 		 */
 		updateFiles?: boolean;
 
diff --git a/lib/pages/color-setting.d.ts b/lib/pages/color-setting.d.ts
@@ -2,7 +2,7 @@ import {Section} from './section'
 import {SectionSetting} from './section-setting'
 
 /**
- * NOT IMPLEMENTED
+ * @deprecated Not currently implemented
  */
 export class ColorSetting extends SectionSetting<ColorSetting> {
 	constructor(section: Section, id: string)
diff --git a/lib/pages/color-setting.js b/lib/pages/color-setting.js
@@ -2,7 +2,10 @@
 
 const SectionSetting = require('./section-setting.js')
 
-module.exports = class ColorSetting extends SectionSetting { // TODO - is this right?
+/**
+ * @deprecated
+ */
+module.exports = class ColorSetting extends SectionSetting {
 	constructor(section, id) {
 		super(section, id)
 		this._type = 'COLOR'
diff --git a/lib/pages/email-setting.d.ts b/lib/pages/email-setting.d.ts
@@ -2,7 +2,7 @@ import {Section} from './section'
 import {SectionSetting} from './section-setting'
 
 /**
- * An email setting creates an input box with a keyboard appropriate for the entry of email addresses
+ * An email setting creates an input box with a keyboard appropriate for the entry of email addresses.
  * ```
  * section.emailSetting("emailAddress")
  * ```
diff --git a/lib/pages/enum-setting.d.ts b/lib/pages/enum-setting.d.ts
@@ -66,7 +66,7 @@ export enum OptionsStyle {
  *             {id:'red', name:'Red'},
  *             {id:'yellow', name:'Yellow'},
  *             {id:'blue', name:'Blue'}]},
- *         {name: 'primaryColors', options: [
+ *         {name: 'secondaryColors', options: [
  *             {id:'green', name:'Green'},
  *             {id:'orange', name:'Orange'},
  *             {id:'purple', name:'Purple'}]},
@@ -87,7 +87,7 @@ export class EnumSetting extends SectionSetting<EnumSetting> {
 	groupedOptions(groups: OptionGroup[]): EnumSetting
 
 	/**
-	 * Specifies whether this device setting can have multiple values.
+	 * Specifies whether this enum setting can have multiple values.
 	 */
 	multiple(value: boolean): EnumSetting
 
diff --git a/lib/pages/image-setting.d.ts b/lib/pages/image-setting.d.ts
@@ -2,7 +2,7 @@ import {Section} from './section'
 import {SectionSetting} from './section-setting'
 
 /**
- * An image settings simply displays an image on the configuration page. There is no user input involved.
+ * An image setting simply displays an image on the configuration page. There is no user input involved.
  * ```
  * section.imageSetting('banner')
  *     .image('https://mysite/image.png')
diff --git a/lib/pages/images-setting.d.ts b/lib/pages/images-setting.d.ts
@@ -2,7 +2,7 @@ import {Section} from './section'
 import {SectionSetting} from './section-setting'
 
 /**
- * An images settings displays a carousel of images on the configuration page. There is no user input involved.
+ * An images setting displays a carousel of images on the configuration page. There is no user input involved.
  * ```
  * section.imageSetting('banner')
  *     .images(['https://mysite/image.png', 'https://mysite/image2.png', 'https://mysite/image3.png')
diff --git a/lib/pages/link-setting.d.ts b/lib/pages/link-setting.d.ts
@@ -9,7 +9,7 @@ export enum LinkStyle {
 }
 
 /**
- * A link setting display a hypertext link that opens an external web page in a browser window. It
+ * A link setting displays a hypertext link that opens an external web page in a browser window. It
  * does not replace the current configuration page window.
  * ```
  * section.linkSetting('moreInfo')
diff --git a/lib/pages/mode-setting.d.ts b/lib/pages/mode-setting.d.ts
@@ -8,12 +8,12 @@ export enum ModeStyle {
 }
 
 /**
- * A device setting creates a control that allows the user to select one or more location modes. To allow the selection
+ * A mode setting creates a control that allows the user to select one or more location modes. To allow the selection
  * of only one mode:
  * ```
  * section.modeSetting('targetMode')
  * ```
- * The allow the selection of more than one mode:
+ * To allow the selection of more than one mode:
  * ```
  * section.modeSetting('permittedModes').multiple(true)
  * ```
@@ -27,7 +27,7 @@ export class ModeSetting extends SectionSetting<ModeSetting> {
 	closeOnSelection(value: boolean): ModeSetting
 
 	/**
-	 * Specifies whether this device setting can have multiple values.
+	 * Specifies whether this mode setting can have multiple values.
 	 */
 	multiple(boolean: true): ModeSetting
 
diff --git a/lib/pages/page-setting.d.ts b/lib/pages/page-setting.d.ts
@@ -9,7 +9,7 @@ export enum PageLinkStyle {
 }
 
 /**
- * A page setting create a link to another configuration page. Tapping on the link displays
+ * A page setting creates a link to another configuration page. Tapping on the link displays
  * the linked page.
  */
 export class PageSetting extends SectionSetting<PageSetting> {
diff --git a/lib/pages/page.d.ts b/lib/pages/page.d.ts
@@ -34,7 +34,7 @@ export class Page {
 	nextPageId(value: string): Page
 
 	/**
-	* Set the text of the next page link. Defaults to "Next"
+	* Set the text of the next page link (defaults to "Next"). Only applies if style is `SPLASH`
 	*/
 	nextText(value: string): Page
 
diff --git a/lib/pages/scene-setting.d.ts b/lib/pages/scene-setting.d.ts
@@ -9,7 +9,7 @@ export enum SceneStyle {
 }
 
 /**
- * A scene setting display a control that allows one or more scenes to be selected.
+ * A scene setting displays a control that allows one or more scenes to be selected.
  * ```
  * section.sceneSetting('selectedScene')
  * ```
@@ -23,7 +23,7 @@ export class SceneSetting extends SectionSetting<SceneSetting> {
 	closeOnSelection(value: true): SceneSetting
 
 	/**
-	 * Specifies whether this device setting can have multiple values.
+	 * Specifies whether this scene setting can have multiple values.
 	 */
 	multiple(value: true): SceneSetting
 
diff --git a/lib/pages/section.d.ts b/lib/pages/section.d.ts
@@ -1,7 +1,6 @@
 import { Page } from './page'
 
 import { BooleanSetting } from './boolean-setting'
-// import { ColorSetting } from './color-setting'
 import { DecimalSetting } from './decimal-setting'
 import { DeviceSetting } from './device-setting'
 import { EmailSetting } from './email-setting'
@@ -81,8 +80,6 @@ export class Section {
 	 */
 	booleanSetting(id: string): BooleanSetting
 
-	// colorSetting(id: string): ColorSetting
-
 	/**
 	 * Creates a new decimal setting
 	 */
diff --git a/lib/pages/section.js b/lib/pages/section.js
@@ -201,6 +201,7 @@ module.exports = class Section {
 	}
 
 	/**
+	 * @deprecated
 	 * Color Setting
 	 *
 	 * @param {String} id Identifier used for i18n localization key
diff --git a/lib/pages/security-setting.d.ts b/lib/pages/security-setting.d.ts
@@ -20,7 +20,7 @@ export class SecuritySetting extends SectionSetting<SecuritySetting> {
 	closeOnSelection(value: boolean): SecuritySetting
 
 	/**
-	 * Specifies whether this device setting can have multiple values.
+	 * Specifies whether this security setting can have multiple values.
 	 */
 	multiple(value: boolean): SecuritySetting
 
diff --git a/lib/pages/sound-setting.d.ts b/lib/pages/sound-setting.d.ts
@@ -28,7 +28,7 @@ export class SoundSetting extends SectionSetting<SoundSetting> {
 	groupedOptions(groupedOptions: SoundOptionGroup[]): SoundSetting
 
 	/**
-	 * Specifies whether this device setting can have multiple values.
+	 * Specifies whether this sound setting can have multiple values.
 	 */
 	multiple(value: boolean): SoundSetting
 
diff --git a/lib/pages/text-setting.d.ts b/lib/pages/text-setting.d.ts
@@ -2,7 +2,7 @@ import {Section} from './section'
 import {SectionSetting} from './section-setting'
 
 /**
- * A text setting create a text input field with full alphanumeric keypad.
+ * A text setting creates a text input field with full alphanumeric keypad.
  * ```
  * section.textSetting('warningMessage')
  * ```
diff --git a/lib/pages/video-setting.d.ts b/lib/pages/video-setting.d.ts
diff --git a/lib/smart-app.d.ts b/lib/smart-app.d.ts
diff --git a/package-lock.json b/package-lock.json
