diff --git a/.changeset/curvy-weeks-matter.md b/.changeset/curvy-weeks-matter.md new file mode 100644 index 0000000000..3975058afe --- /dev/null +++ b/.changeset/curvy-weeks-matter.md @@ -0,0 +1,8 @@ +--- +'@backstage/backend-common': patch +'@backstage/catalog-model': patch +'@backstage/core-components': patch +'@backstage/plugin-techdocs-react': patch +--- + +Updated docstring to be MDX compatible. diff --git a/packages/backend-common/src/reading/FetchUrlReader.ts b/packages/backend-common/src/reading/FetchUrlReader.ts index b83f08c22f..5734beddcf 100644 --- a/packages/backend-common/src/reading/FetchUrlReader.ts +++ b/packages/backend-common/src/reading/FetchUrlReader.ts @@ -39,8 +39,8 @@ export class FetchUrlReader implements UrlReader { * targets to allow, containing the following fields: * * `host`: - * Either full hostnames to match, or subdomain wildcard matchers with a leading `*`. - * For example `example.com` and `*.example.com` are valid values, `prod.*.example.com` is not. + * Either full hostnames to match, or subdomain wildcard matchers with a leading '*'. + * For example 'example.com' and '*.example.com' are valid values, 'prod.*.example.com' is not. * * `paths`: * An optional list of paths which are allowed. If the list is omitted all paths are allowed. diff --git a/packages/catalog-model/src/validation/CommonValidatorFunctions.ts b/packages/catalog-model/src/validation/CommonValidatorFunctions.ts index 8c814412c1..40a85c5331 100644 --- a/packages/catalog-model/src/validation/CommonValidatorFunctions.ts +++ b/packages/catalog-model/src/validation/CommonValidatorFunctions.ts @@ -24,7 +24,7 @@ import lodash from 'lodash'; */ export class CommonValidatorFunctions { /** - * Checks that the value is on the form or , and validates + * Checks that the value is on the form `` or ``, and validates * those parts separately. * * @param value - The value to check diff --git a/packages/core-components/src/components/DependencyGraph/DependencyGraph.tsx b/packages/core-components/src/components/DependencyGraph/DependencyGraph.tsx index 6db8e2dd02..9f447f80cc 100644 --- a/packages/core-components/src/components/DependencyGraph/DependencyGraph.tsx +++ b/packages/core-components/src/components/DependencyGraph/DependencyGraph.tsx @@ -40,7 +40,7 @@ import { ARROW_MARKER_ID } from './constants'; * * @public * @remarks - * and are useful when rendering custom or edge labels + * `` and `` are useful when rendering custom or edge labels */ export interface DependencyGraphProps extends React.SVGProps { diff --git a/packages/core-components/src/layout/ItemCard/ItemCardHeader.tsx b/packages/core-components/src/layout/ItemCard/ItemCardHeader.tsx index 3209848ecb..a34d773ce3 100644 --- a/packages/core-components/src/layout/ItemCard/ItemCardHeader.tsx +++ b/packages/core-components/src/layout/ItemCard/ItemCardHeader.tsx @@ -64,7 +64,7 @@ export type ItemCardHeaderProps = Partial> & { * A simple card header, rendering a default look for "item cards" - cards that * are arranged in a grid for users to select among several options. * - * This component expects to be placed within a MUI . + * This component expects to be placed within a MUI ``. * * Styles for the header can be overridden using the `classes` prop, e.g.: * diff --git a/plugins/techdocs-react/src/addons.tsx b/plugins/techdocs-react/src/addons.tsx index ce5b3eb5cd..a562007260 100644 --- a/plugins/techdocs-react/src/addons.tsx +++ b/plugins/techdocs-react/src/addons.tsx @@ -30,7 +30,7 @@ import { TechDocsAddonLocations, TechDocsAddonOptions } from './types'; export const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1'; /** - * Marks the registry component. + * Marks the `` registry component. * @public */ export const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';