Merge pull request #22545 from adamdmharvey/adamdmharvey/api-ref-doc-edits

chore(docs): Improve API reference wording
This commit is contained in:
Fredrik Adelöw
2024-01-28 17:36:14 +01:00
committed by GitHub
4 changed files with 11 additions and 4 deletions
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/catalog-model': patch
'@backstage/test-utils': patch
'@backstage/plugin-explore': patch
---
Fix wording in API reference
@@ -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
@@ -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 <p> for To the following </p> 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 <p> for To the following </p> 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
+1 -1
View File
@@ -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<GetExploreToolsResponse>;
}