diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.ts b/packages/frontend-plugin-api/src/wiring/createExtension.ts index b700ae5297..0c0b75a572 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtension.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtension.ts @@ -308,16 +308,16 @@ export type ExtensionDefinition< * * @example * - *```ts - *const myExtension = createExtension({ - * name: 'example', - * attachTo: { id: 'app', input: 'root' }, - * output: [coreExtensionData.reactElement], - * factory() { - * return [coreExtensionData.reactElement(

Hello, world!

)]; - * }, - *}); - *``` + * ```ts + * const myExtension = createExtension({ + * name: 'example', + * attachTo: { id: 'app', input: 'root' }, + * output: [coreExtensionData.reactElement], + * factory() { + * return [coreExtensionData.reactElement(

Hello, world!

)]; + * }, + * }); + * ``` * * @public */ diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts index 53179a82d7..1a24eed712 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts @@ -419,7 +419,7 @@ function unwrapParams( * blueprint, removing a lot of the boilerplate and complexity that is otherwise * needed to create an extension. * - * Each blueprint has its own `kind` that helps identity and group the + * Each blueprint has its own `kind` that helps identify and group the * extensions that have been created with it. For example the * {@link PageBlueprint} has the kind `'page'`, and extensions created with it * will be given the ID `'page:[/]'`. Blueprints should always diff --git a/packages/frontend-plugin-api/src/wiring/createFrontendModule.ts b/packages/frontend-plugin-api/src/wiring/createFrontendModule.ts index 00b569657f..7921f98635 100644 --- a/packages/frontend-plugin-api/src/wiring/createFrontendModule.ts +++ b/packages/frontend-plugin-api/src/wiring/createFrontendModule.ts @@ -46,15 +46,15 @@ export interface InternalFrontendModule extends FrontendModule { } /** - * Creates a new module instance that can be installed in a Backstage app. + * Creates a new module that can be installed in a Backstage app. * * @remarks * * Modules are used to add or override extensions for an existing plugin. If a * module provides an extension with the same ID as one provided by the plugin, - * the extension provided by the module will always take presedence. + * the extension provided by the module will always take precedence. * - * Every module instance is created for a specific plugin by providing the + * Every module is created for a specific plugin by providing the * unique ID of the plugin that the module should be installed for. If that * plugin is not present in the app, the module will be ignored and have no * effect. @@ -67,20 +67,20 @@ export interface InternalFrontendModule extends FrontendModule { * * @example * - *```tsx - *import { createFrontendModule } from '@backstage/frontend-plugin-api'; + * ```tsx + * import { createFrontendModule } from '@backstage/frontend-plugin-api'; * - *export const exampleModuleCustomPage = createFrontendModule({ - * pluginId: 'example', - * extensions: [ - * // Overrides the default page for the 'example' plugin - * PageBlueprint.make({ - * path: '/example', - * loader: () => import('./CustomPage').then(m => ), - * }), - * ], - *}); - *``` + * export const exampleModuleCustomPage = createFrontendModule({ + * pluginId: 'example', + * extensions: [ + * // Overrides the default page for the 'example' plugin + * PageBlueprint.make({ + * path: '/example', + * loader: () => import('./CustomPage').then(m => ), + * }), + * ], + * }); + * ``` * * @public */ diff --git a/packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts b/packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts index 07280818e9..f545195e81 100644 --- a/packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts +++ b/packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts @@ -136,11 +136,11 @@ export interface PluginOptions< } /** - * Creates a new plugin instance that can be installed in a Backstage app. + * Creates a new plugin that can be installed in a Backstage app. * * @remarks * - * Every plugin instance is created with a unique ID and a set of extensions + * Every plugin is created with a unique ID and a set of extensions * that are installed as part of the plugin. * * For more information on how plugins work, see the