From 60ba48c5916d425f54667a3d0566635e961a1606 Mon Sep 17 00:00:00 2001
From: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
Date: Fri, 26 Jan 2024 11:06:50 -0500
Subject: [PATCH 1/2] chore(docs): Improve API reference wording
Signed-off-by: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
---
packages/catalog-model/src/kinds/relations.ts | 2 +-
packages/test-utils/src/testUtils/TestApiProvider.tsx | 4 ++--
plugins/explore/src/api/ExploreApi.ts | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/packages/catalog-model/src/kinds/relations.ts b/packages/catalog-model/src/kinds/relations.ts
index 4d545c9d35..69f9aae1c4 100644
--- a/packages/catalog-model/src/kinds/relations.ts
+++ b/packages/catalog-model/src/kinds/relations.ts
@@ -114,7 +114,7 @@ export const RELATION_CHILD_OF = 'childOf';
export const RELATION_MEMBER_OF = 'memberOf';
/**
- * A relation from a group to its member, typcally a user in a group. Reversed direction of
+ * A relation from a group to its member, typically a user in a group. Reversed direction of
* {@link RELATION_MEMBER_OF}.
*
* @public
diff --git a/packages/test-utils/src/testUtils/TestApiProvider.tsx b/packages/test-utils/src/testUtils/TestApiProvider.tsx
index c212b94bea..59fafbeadb 100644
--- a/packages/test-utils/src/testUtils/TestApiProvider.tsx
+++ b/packages/test-utils/src/testUtils/TestApiProvider.tsx
@@ -93,8 +93,8 @@ export class TestApiRegistry implements ApiHolder {
*
* @remarks
* todo: remove this remark tag and ship in the api-reference. There's some odd formatting going on when this is made into a markdown doc, that there's no line break between
- * the emmited for To the following
so what happens is that when parsing in docusaurus, it thinks that the code block is mdx rather than a code
- * snippet. Just ommiting this from the report for now until we can work out how to fix laterr.
+ * the emitted for To the following
so what happens is that when parsing in docusaurus, it thinks that the code block is mdx rather than a code
+ * snippet. Just omitting this from the report for now until we can work out how to fix later.
* A migration from `ApiRegistry` and `ApiProvider` might look like this, from:
*
* ```tsx
diff --git a/plugins/explore/src/api/ExploreApi.ts b/plugins/explore/src/api/ExploreApi.ts
index ef9eb646b7..e5d8c7efa6 100644
--- a/plugins/explore/src/api/ExploreApi.ts
+++ b/plugins/explore/src/api/ExploreApi.ts
@@ -29,7 +29,7 @@ export interface ExploreApi {
/**
* Returns a list of explore tools.
*
- * @param request - The The request query options
+ * @param request - The request query options
*/
getTools(request?: GetExploreToolsRequest): Promise;
}
From 07e7d12db6e72d85617aecfe233326327cbe9144 Mon Sep 17 00:00:00 2001
From: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
Date: Fri, 26 Jan 2024 11:08:10 -0500
Subject: [PATCH 2/2] chore: Add changeset
Signed-off-by: Adam Harvey <33203301+adamdmharvey@users.noreply.github.com>
---
.changeset/hot-paws-tap.md | 7 +++++++
1 file changed, 7 insertions(+)
create mode 100644 .changeset/hot-paws-tap.md
diff --git a/.changeset/hot-paws-tap.md b/.changeset/hot-paws-tap.md
new file mode 100644
index 0000000000..30d8b396ba
--- /dev/null
+++ b/.changeset/hot-paws-tap.md
@@ -0,0 +1,7 @@
+---
+'@backstage/catalog-model': patch
+'@backstage/test-utils': patch
+'@backstage/plugin-explore': patch
+---
+
+Fix wording in API reference