From d0dd3d5eb9cdfe421d0aa69a7c8a01d448ca3718 Mon Sep 17 00:00:00 2001 From: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Date: Fri, 18 Nov 2022 14:03:34 -0600 Subject: [PATCH] Fixed API Report warnings Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> --- packages/core-components/api-report.md | 3 --- .../src/components/AlertDisplay/AlertDisplay.tsx | 4 ++-- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index 63c10f3387..d8ea9d2bbe 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -55,9 +55,6 @@ import { WithStyles } from '@material-ui/core/styles'; // @public export function AlertDisplay(props: AlertDisplayProps): JSX.Element | null; -// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters -// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters -// // @public export type AlertDisplayProps = { anchorOrigin?: { diff --git a/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx b/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx index db90952104..1f54abfe19 100644 --- a/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx +++ b/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx @@ -30,8 +30,8 @@ import React, { useEffect, useState } from 'react'; * * Shown as SnackBar at the center top of the page by default. Configurable with props. * - * @param anchorOrigin.vertical - Vertical orientation of where the AlertDisplay will be located - * @param anchorOrigin.horizontal - Horizontal orientation of where the AlertDisplay will be located + * @param anchorOrigin - The `vertical` property will set the vertical orientation of where the AlertDisplay will be located + * and the `horizontal` property will set the horizontal orientation of where the AlertDisplay will be located * @param transientTimeoutMs - Number of milliseconds a transient alert will stay open for. Default value is 5000 * * @example