PR fixes

Signed-off-by: lukzerom <lukzerom@gmail.com>
2021-12-21 17:16:05 +01:00
parent 2140643512
commit e643a59dca
18 changed files with 7 additions and 25 deletions
@@ -50,7 +50,6 @@ type Props = {
 * Various placeholder views for empty state pages
 *
 * @public
- * @remarks
 *
 */
 export function EmptyState(props: Props) {
@@ -112,7 +112,6 @@ type Placement = {
 * One-time, round 'telescope' animation showing new feature.
 *
 * @public
- * @remarks
 *
 */
 export function FeatureCalloutCircular(props: PropsWithChildren<Props>) {
@@ -41,7 +41,6 @@ type Props = {
 * HTML nav tag with links mapped inside
 *
 * @public
- * @remarks
 *
 */
 export function HeaderIconLinkRow(props: Props) {
@@ -202,7 +202,6 @@ function useSmoothScroll(
 * Horizontal scrollable component with arrows to navigate
 *
 * @public
- * @remarks
 *
 */
 export function HorizontalScrollGrid(props: PropsWithChildren<Props>) {
@@ -100,7 +100,6 @@ export const getProgressColor: GaugePropsGetColor = ({
 * Circular Progress Bar
 *
 * @public
- * @remarks
 *
 */

@@ -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) {
@@ -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) {
@@ -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) {
@@ -55,7 +55,6 @@ const StyledBox = withStyles(
 * Breadcrumbs component to show navigation hierarchical structure
 *
 * @public
- * @remarks
 *
 */
 export function Breadcrumbs(props: Props) {
@@ -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
 *
 */

@@ -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
 *
 */

@@ -59,7 +59,6 @@ const useStyles = makeStyles<BackstageTheme>(
 * Error page with status and description
 *
 * @public
- * @remarks
 *
 */
 export function ErrorPage(props: IErrorPageProps) {
@@ -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<Props>) {
@@ -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) {
@@ -72,7 +72,6 @@ type HeaderTabsProps = {
 * Horizontal Tabs component
 *
 * @public
- * @remarks
 *
 */
 export function HeaderTabs(props: HeaderTabsProps) {
@@ -148,7 +148,6 @@ type Props = {
 * Material-ui card with header , content and actions footer
 *
 * @public
- * @remarks
 *
 */
 export function InfoCard(props: Props): JSX.Element {
@@ -92,7 +92,6 @@ type IntroCardProps = {
 * Closable card with information from Navigation Sidebar
 *
 * @public
- * @remarks
 *
 */

@@ -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<CardTabProps>) {