From c2d50a0073f8941ccd4ead9711606bfaec36250b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Tue, 26 Oct 2021 14:13:17 +0200 Subject: [PATCH] Add docs to the last export of cli-common MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/great-tomatoes-cheat.md | 5 +++++ packages/cli-common/api-report.md | 2 +- packages/cli-common/src/paths.ts | 7 ++++++- 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 .changeset/great-tomatoes-cheat.md diff --git a/.changeset/great-tomatoes-cheat.md b/.changeset/great-tomatoes-cheat.md new file mode 100644 index 0000000000..547e89c6d0 --- /dev/null +++ b/.changeset/great-tomatoes-cheat.md @@ -0,0 +1,5 @@ +--- +'@backstage/cli-common': patch +--- + +Add docs to the last export of cli-common diff --git a/packages/cli-common/api-report.md b/packages/cli-common/api-report.md index 371671e63a..4b61cfedb8 100644 --- a/packages/cli-common/api-report.md +++ b/packages/cli-common/api-report.md @@ -21,6 +21,6 @@ export type Paths = { resolveTargetRoot: ResolveFunc; }; -// @public (undocumented) +// @public export type ResolveFunc = (...paths: string[]) => string; ``` diff --git a/packages/cli-common/src/paths.ts b/packages/cli-common/src/paths.ts index 4aa9d4b76e..c9f486752f 100644 --- a/packages/cli-common/src/paths.ts +++ b/packages/cli-common/src/paths.ts @@ -17,7 +17,12 @@ import fs from 'fs'; import { dirname, resolve as resolvePath } from 'path'; -/** @public */ +/** + * A function that takes a set of path fragments and resolves them into a + * single complete path, relative to some root. + * + * @public + */ export type ResolveFunc = (...paths: string[]) => string; /**