Doc updates

microsoft · Dec 13, 2023 · fcd5e40 · fcd5e40
1 parent 876fd0b
commit fcd5e40
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/packages/web-components/fast-foundation/docs/api-report.md b/packages/web-components/fast-foundation/docs/api-report.md
@@ -2529,7 +2529,7 @@ export type PickerOptions = {
 // @public
 export function pickerTemplate<T extends FASTPicker>(options: PickerOptions): ElementViewTemplate<T>;
 
-// @public (undocumented)
+// @public
 export const progressIndicatorTemplate: ViewTemplate<any, any>;
 
 // @public
@@ -2538,7 +2538,7 @@ export type ProgressOptions = {
     indeterminateIndicator?: StaticallyComposableHTML<FASTProgress>;
 };
 
-// @public (undocumented)
+// @public
 export const progressRingIndicatorTemplate: ViewTemplate<any, any>;
 
 // @public

diff --git a/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts b/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts
@@ -5,6 +5,7 @@ import type { FASTProgressRing } from "./progress-ring.js";
 import type { ProgressRingOptions } from "./progress-ring.options.js";
 
 /**
+ * The default template for the indicator element of the {@link @microsoft/fast-foundation#FASTProgressRing} component.
  * @public
  */
 export const progressRingIndicatorTemplate = html`

diff --git a/packages/web-components/fast-foundation/src/progress-ring/progress-ring.ts b/packages/web-components/fast-foundation/src/progress-ring/progress-ring.ts
@@ -1,7 +1,7 @@
 import { FASTBaseProgress } from "../progress/base-progress.js";
 
 /**
- * An circular Progress HTML Element.
+ * A circular Progress HTML Element.
  * Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar }.
  *
  * @slot determinate - The slot for the determinate indicator

diff --git a/packages/web-components/fast-foundation/src/progress/README.md b/packages/web-components/fast-foundation/src/progress/README.md
@@ -3,7 +3,7 @@ id: progress
 title: fast-progress
 sidebar_label: progress
 custom_edit_url: https://github.com/microsoft/fast/edit/master/packages/web-components/fast-foundation/src/progress/README.md
-description: fast-progress is a web component used to display the length of time a process will take or to visualize percentage value.
+description: fast-progress is used to display the length of time a process will take or to visualize percentage value or to represent an unspecified wait time.
 ---
 
 *Progress* and *progress ring* are used to display the length of time a process will take or to visualize percentage value (referred to as a **determinate** state) and to represent an unspecified wait time (referred to as an **indeterminate** state). *Progress* components are typically visually represented by a circular or linear animation. When the `value` attribute is passed the state is **determinate**, otherwise it is **indeterminate**. 
@@ -40,8 +40,7 @@ import {
 provideFASTDesignSystem()
     .register(
         fastProgress({
-            indeterminateIndicator1: `...your indeterminate indicator...`,
-            indeterminateIndicator2: `...your indeterminate indicator...`
+            indeterminateIndicator: `...your indeterminate indicator...`
         }),
         fastProgressRing({
             indeterminateIndicator: `...your indeterminate indicator...`
@@ -79,8 +78,7 @@ export const myProgress = Progress.compose<ProgressOptions>({
     baseName: "progress",
     template,
     styles,
-    indeterminateIndicator1: `...default indeterminate indicator...`,
-    indeterminateIndicator2: `...default indeterminate indicator...`,
+    indeterminateIndicator: `...default indeterminate indicator...`,
 });
 ```
 

diff --git a/packages/web-components/fast-foundation/src/progress/progress.template.ts b/packages/web-components/fast-foundation/src/progress/progress.template.ts
@@ -5,6 +5,7 @@ import type { FASTProgress } from "./progress.js";
 import type { ProgressOptions } from "./progress.options.js";
 
 /**
+ * The default template for the indicator element of the {@link @microsoft/fast-foundation#FASTProgressRing} component.
  * @public
  */
 export const progressIndicatorTemplate = html`

diff --git a/packages/web-components/fast-foundation/src/progress/progress.ts b/packages/web-components/fast-foundation/src/progress/progress.ts
@@ -1,7 +1,7 @@
 import { FASTBaseProgress } from "./base-progress.js";
 
 /**
- * An Progress HTML Element.
+ * A Progress HTML Element.
  * Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar }.
  *
  * @slot determinate - The slot for the determinate indicator