From 39b54c6dd033eeffd157b32bee1e734bfb7d779d Mon Sep 17 00:00:00 2001 From: Robert Bunning Date: Wed, 21 Dec 2022 12:44:16 -0500 Subject: [PATCH] Fixed missing hyphen in param tag Signed-off-by: Robert Bunning --- plugins/adr/api-report.md | 2 -- plugins/adr/src/hooks/adrFileFetcher.ts | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/plugins/adr/api-report.md b/plugins/adr/api-report.md index 99d3e537a3..2a49e89b2d 100644 --- a/plugins/adr/api-report.md +++ b/plugins/adr/api-report.md @@ -22,9 +22,7 @@ export type AdrContentDecorator = (adrInfo: { // @public export interface AdrFileFetcher { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen useGetAdrFilesAtUrl: (url: string) => any; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen useReadAdrFileAtUrl: (url: string) => any; } diff --git a/plugins/adr/src/hooks/adrFileFetcher.ts b/plugins/adr/src/hooks/adrFileFetcher.ts index a9dec1105e..fa690556e6 100644 --- a/plugins/adr/src/hooks/adrFileFetcher.ts +++ b/plugins/adr/src/hooks/adrFileFetcher.ts @@ -50,14 +50,14 @@ export interface AdrFileFetcher { /** * A hook to get a listing of adr files that exist at the provided url * - * @param url The url to get files from + * @param url - The url to get files from */ useGetAdrFilesAtUrl: (url: string) => any; /** * A hook to get the contents of the adr file at the provided url * - * @param url The url of the adr file + * @param url - The url of the adr file */ useReadAdrFileAtUrl: (url: string) => any; }