From 4ba24c0d747c965114ab8b15ea5e1ad5de4cbd47 Mon Sep 17 00:00:00 2001 From: Robb Hamilton Date: Tue, 29 Aug 2023 15:56:18 -0400 Subject: [PATCH] OCPBUGS-18306: fix useDeleteModal Example formatting --- frontend/packages/console-dynamic-plugin-sdk/docs/api.md | 4 +++- .../console-dynamic-plugin-sdk/src/api/dynamic-core-api.ts | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/frontend/packages/console-dynamic-plugin-sdk/docs/api.md b/frontend/packages/console-dynamic-plugin-sdk/docs/api.md index ca00d4819dc..a36acbc2751 100644 --- a/frontend/packages/console-dynamic-plugin-sdk/docs/api.md +++ b/frontend/packages/console-dynamic-plugin-sdk/docs/api.md @@ -2295,11 +2295,13 @@ A hook that provides a callback to launch a modal for deleting a resource. ### Example +```tsx const DeletePodButton = ({ pod }) => { const { t } = useTranslation(); - const launchDeleteModal = useDeleteModal(pod); + const launchDeleteModal = useDeleteModal(pod); return } +``` diff --git a/frontend/packages/console-dynamic-plugin-sdk/src/api/dynamic-core-api.ts b/frontend/packages/console-dynamic-plugin-sdk/src/api/dynamic-core-api.ts index 9057ffecef4..093aa26cf55 100644 --- a/frontend/packages/console-dynamic-plugin-sdk/src/api/dynamic-core-api.ts +++ b/frontend/packages/console-dynamic-plugin-sdk/src/api/dynamic-core-api.ts @@ -823,11 +823,13 @@ export const useAnnotationsModal: UseAnnotationsModal = require('@console/shared * @param deleteAllResources - (optional) A function to delete all resources of the same kind. * @returns A function which will launch a modal for deleting a resource. * @example + * ```tsx * const DeletePodButton = ({ pod }) => { * const { t } = useTranslation(); - * const launchDeleteModal = useDeleteModal(pod); + * const launchDeleteModal = useDeleteModal(pod); * return * } + * ``` */ export const useDeleteModal: UseDeleteModal = require('@console/shared/src/hooks/useDeleteModal')