From e643a59dca04a24cebe661c62c62fb4c1f75bd17 Mon Sep 17 00:00:00 2001 From: lukzerom Date: Tue, 21 Dec 2021 17:16:05 +0100 Subject: [PATCH] PR fixes Signed-off-by: lukzerom --- .../core-components/src/components/EmptyState/EmptyState.tsx | 1 - .../src/components/FeatureDiscovery/FeatureCalloutCircular.tsx | 1 - .../src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx | 1 - .../components/HorizontalScrollGrid/HorizontalScrollGrid.tsx | 1 - packages/core-components/src/components/ProgressBars/Gauge.tsx | 1 - .../core-components/src/components/ProgressBars/GaugeCard.tsx | 3 +-- packages/core-components/src/icons/icons.tsx | 3 +-- packages/core-components/src/layout/BottomLink/BottomLink.tsx | 3 +-- .../core-components/src/layout/Breadcrumbs/Breadcrumbs.tsx | 1 - packages/core-components/src/layout/Content/Content.tsx | 3 +-- .../core-components/src/layout/ContentHeader/ContentHeader.tsx | 3 +-- packages/core-components/src/layout/ErrorPage/ErrorPage.tsx | 1 - packages/core-components/src/layout/Header/Header.tsx | 1 - .../core-components/src/layout/HeaderLabel/HeaderLabel.tsx | 3 +-- packages/core-components/src/layout/HeaderTabs/HeaderTabs.tsx | 1 - packages/core-components/src/layout/InfoCard/InfoCard.tsx | 1 - packages/core-components/src/layout/Sidebar/Intro.tsx | 1 - packages/core-components/src/layout/TabbedCard/TabbedCard.tsx | 3 +-- 18 files changed, 7 insertions(+), 25 deletions(-) diff --git a/packages/core-components/src/components/EmptyState/EmptyState.tsx b/packages/core-components/src/components/EmptyState/EmptyState.tsx index 2d0891bd19..b4fbf6d510 100644 --- a/packages/core-components/src/components/EmptyState/EmptyState.tsx +++ b/packages/core-components/src/components/EmptyState/EmptyState.tsx @@ -50,7 +50,6 @@ type Props = { * Various placeholder views for empty state pages * * @public - * @remarks * */ export function EmptyState(props: Props) { diff --git a/packages/core-components/src/components/FeatureDiscovery/FeatureCalloutCircular.tsx b/packages/core-components/src/components/FeatureDiscovery/FeatureCalloutCircular.tsx index 61d97d7760..cac3c8166b 100644 --- a/packages/core-components/src/components/FeatureDiscovery/FeatureCalloutCircular.tsx +++ b/packages/core-components/src/components/FeatureDiscovery/FeatureCalloutCircular.tsx @@ -112,7 +112,6 @@ type Placement = { * One-time, round 'telescope' animation showing new feature. * * @public - * @remarks * */ export function FeatureCalloutCircular(props: PropsWithChildren) { diff --git a/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx b/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx index beb44fc771..e30d407377 100644 --- a/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx +++ b/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx @@ -41,7 +41,6 @@ type Props = { * HTML nav tag with links mapped inside * * @public - * @remarks * */ export function HeaderIconLinkRow(props: Props) { diff --git a/packages/core-components/src/components/HorizontalScrollGrid/HorizontalScrollGrid.tsx b/packages/core-components/src/components/HorizontalScrollGrid/HorizontalScrollGrid.tsx index 91137064be..8c5dc4d530 100644 --- a/packages/core-components/src/components/HorizontalScrollGrid/HorizontalScrollGrid.tsx +++ b/packages/core-components/src/components/HorizontalScrollGrid/HorizontalScrollGrid.tsx @@ -202,7 +202,6 @@ function useSmoothScroll( * Horizontal scrollable component with arrows to navigate * * @public - * @remarks * */ export function HorizontalScrollGrid(props: PropsWithChildren) { diff --git a/packages/core-components/src/components/ProgressBars/Gauge.tsx b/packages/core-components/src/components/ProgressBars/Gauge.tsx index 858565f773..0336ebc990 100644 --- a/packages/core-components/src/components/ProgressBars/Gauge.tsx +++ b/packages/core-components/src/components/ProgressBars/Gauge.tsx @@ -100,7 +100,6 @@ export const getProgressColor: GaugePropsGetColor = ({ * Circular Progress Bar * * @public - * @remarks * */ diff --git a/packages/core-components/src/components/ProgressBars/GaugeCard.tsx b/packages/core-components/src/components/ProgressBars/GaugeCard.tsx index 6191eb0cd8..9e6c19ebfe 100644 --- a/packages/core-components/src/components/ProgressBars/GaugeCard.tsx +++ b/packages/core-components/src/components/ProgressBars/GaugeCard.tsx @@ -45,10 +45,9 @@ const useStyles = makeStyles( ); /** - * {@link Gauge | Gauge} with header, subheader and footer + * {@link Gauge} with header, subheader and footer * * @public - * @remarks * */ export function GaugeCard(props: Props) { diff --git a/packages/core-components/src/icons/icons.tsx b/packages/core-components/src/icons/icons.tsx index 2f75bdfa39..8d22af4664 100644 --- a/packages/core-components/src/icons/icons.tsx +++ b/packages/core-components/src/icons/icons.tsx @@ -28,10 +28,9 @@ function useSystemIcon(key: string, props: IconComponentProps) { // Should match the list of overridable system icon keys in @backstage/core-app-api /** - * Broken Image Icon from material UI library + * Broken Image Icon * * @public - * @remarks * */ export function BrokenImageIcon(props: IconComponentProps) { diff --git a/packages/core-components/src/layout/BottomLink/BottomLink.tsx b/packages/core-components/src/layout/BottomLink/BottomLink.tsx index 420752ffe4..c9c1659284 100644 --- a/packages/core-components/src/layout/BottomLink/BottomLink.tsx +++ b/packages/core-components/src/layout/BottomLink/BottomLink.tsx @@ -51,10 +51,9 @@ export type BottomLinkProps = { }; /** - * Footer with link used in {@link InfoCard | InfoCard } and {@link TabbedCard | TabbedCard} + * Footer with link used in {@link InfoCard } and {@link TabbedCard} * * @public - * @remarks * */ export function BottomLink(props: BottomLinkProps) { diff --git a/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.tsx b/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.tsx index 02c595aadd..0d11068074 100644 --- a/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.tsx +++ b/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.tsx @@ -55,7 +55,6 @@ const StyledBox = withStyles( * Breadcrumbs component to show navigation hierarchical structure * * @public - * @remarks * */ export function Breadcrumbs(props: Props) { diff --git a/packages/core-components/src/layout/Content/Content.tsx b/packages/core-components/src/layout/Content/Content.tsx index 12619666f9..1d91556663 100644 --- a/packages/core-components/src/layout/Content/Content.tsx +++ b/packages/core-components/src/layout/Content/Content.tsx @@ -54,10 +54,9 @@ type Props = { }; /** - * HTML article tag wrapped with text alignment properties and custom className + * The main content part inside a {@link Page}. * * @public - * @remarks * */ diff --git a/packages/core-components/src/layout/ContentHeader/ContentHeader.tsx b/packages/core-components/src/layout/ContentHeader/ContentHeader.tsx index 440408315d..5a9ed3a77e 100644 --- a/packages/core-components/src/layout/ContentHeader/ContentHeader.tsx +++ b/packages/core-components/src/layout/ContentHeader/ContentHeader.tsx @@ -95,10 +95,9 @@ type ContentHeaderProps = { }; /** - * Wrapper of material-ui h2 Typography component with body2 description + * A header at the top inside a {@link Content}. * * @public - * @remarks * */ diff --git a/packages/core-components/src/layout/ErrorPage/ErrorPage.tsx b/packages/core-components/src/layout/ErrorPage/ErrorPage.tsx index 2daef184e3..08c002d849 100644 --- a/packages/core-components/src/layout/ErrorPage/ErrorPage.tsx +++ b/packages/core-components/src/layout/ErrorPage/ErrorPage.tsx @@ -59,7 +59,6 @@ const useStyles = makeStyles( * Error page with status and description * * @public - * @remarks * */ export function ErrorPage(props: IErrorPageProps) { diff --git a/packages/core-components/src/layout/Header/Header.tsx b/packages/core-components/src/layout/Header/Header.tsx index 46ea1694e3..9ff0612b9f 100644 --- a/packages/core-components/src/layout/Header/Header.tsx +++ b/packages/core-components/src/layout/Header/Header.tsx @@ -193,7 +193,6 @@ const SubtitleFragment = ({ classes, subtitle }: SubtitleFragmentProps) => { * Backstage main header with abstract color background in multiple variants * * @public - * @remarks * */ export function Header(props: PropsWithChildren) { diff --git a/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx b/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx index d29d8cf96b..f523a5319b 100644 --- a/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx +++ b/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx @@ -61,10 +61,9 @@ type HeaderLabelProps = { }; /** - * Additional label to main {@link Header | Header} + * Additional label to main {@link Header} * * @public - * @remarks * */ export function HeaderLabel(props: HeaderLabelProps) { diff --git a/packages/core-components/src/layout/HeaderTabs/HeaderTabs.tsx b/packages/core-components/src/layout/HeaderTabs/HeaderTabs.tsx index c27d12114a..bee4bdfce2 100644 --- a/packages/core-components/src/layout/HeaderTabs/HeaderTabs.tsx +++ b/packages/core-components/src/layout/HeaderTabs/HeaderTabs.tsx @@ -72,7 +72,6 @@ type HeaderTabsProps = { * Horizontal Tabs component * * @public - * @remarks * */ export function HeaderTabs(props: HeaderTabsProps) { diff --git a/packages/core-components/src/layout/InfoCard/InfoCard.tsx b/packages/core-components/src/layout/InfoCard/InfoCard.tsx index 2b1c002456..f1e67904f1 100644 --- a/packages/core-components/src/layout/InfoCard/InfoCard.tsx +++ b/packages/core-components/src/layout/InfoCard/InfoCard.tsx @@ -148,7 +148,6 @@ type Props = { * Material-ui card with header , content and actions footer * * @public - * @remarks * */ export function InfoCard(props: Props): JSX.Element { diff --git a/packages/core-components/src/layout/Sidebar/Intro.tsx b/packages/core-components/src/layout/Sidebar/Intro.tsx index 9dd41d6c3e..511a51fd9c 100644 --- a/packages/core-components/src/layout/Sidebar/Intro.tsx +++ b/packages/core-components/src/layout/Sidebar/Intro.tsx @@ -92,7 +92,6 @@ type IntroCardProps = { * Closable card with information from Navigation Sidebar * * @public - * @remarks * */ diff --git a/packages/core-components/src/layout/TabbedCard/TabbedCard.tsx b/packages/core-components/src/layout/TabbedCard/TabbedCard.tsx index 1fcda30158..06e9f53224 100644 --- a/packages/core-components/src/layout/TabbedCard/TabbedCard.tsx +++ b/packages/core-components/src/layout/TabbedCard/TabbedCard.tsx @@ -150,10 +150,9 @@ type CardTabProps = TabProps & { }; /** - * Card tab component used in {@link TabbedCard | TabbedCard} + * Card tab component used in {@link TabbedCard} * * @public - * @remarks * */ export function CardTab(props: PropsWithChildren) {