From 26518c1d68bf8af765533db50847905cfd883527 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 10 Dec 2020 16:03:25 -0500 Subject: [PATCH] Minor JSDoc tweaks --- packages/core-api/src/apis/definitions/DiscoveryApi.ts | 2 +- packages/core-api/src/apis/definitions/ErrorApi.ts | 4 ++-- packages/core-api/src/apis/definitions/IdentityApi.ts | 3 +-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/core-api/src/apis/definitions/DiscoveryApi.ts b/packages/core-api/src/apis/definitions/DiscoveryApi.ts index 9777835ec8..f62a97b61a 100644 --- a/packages/core-api/src/apis/definitions/DiscoveryApi.ts +++ b/packages/core-api/src/apis/definitions/DiscoveryApi.ts @@ -31,7 +31,7 @@ export type DiscoveryApi = { /** * Returns the HTTP base backend URL for a given plugin, without a trailing slash. * - * This method must always be called just before making a request. as opposed to + * This method must always be called just before making a request, as opposed to * fetching the URL when constructing an API client. That is to ensure that more * flexible routing patterns can be supported. * diff --git a/packages/core-api/src/apis/definitions/ErrorApi.ts b/packages/core-api/src/apis/definitions/ErrorApi.ts index edd6966968..dfa08130cd 100644 --- a/packages/core-api/src/apis/definitions/ErrorApi.ts +++ b/packages/core-api/src/apis/definitions/ErrorApi.ts @@ -42,10 +42,10 @@ export type ErrorContext = { * to report errors for collection by error reporting services. * * If an error can be displayed inline, e.g. as feedback in a form, that should be - * preferred over relying on this API to display the error. The main use of this api + * preferred over relying on this API to display the error. The main use of this API * for displaying errors should be for asynchronous errors, such as a failing background process. * - * Even if an error is displayed inline, it should still be reported through this api + * Even if an error is displayed inline, it should still be reported through this API * if it would be useful to collect or log it for debugging purposes, but with * the hidden flag set. For example, an error arising from form field validation * should probably not be reported, while a failed REST call would be useful to report. diff --git a/packages/core-api/src/apis/definitions/IdentityApi.ts b/packages/core-api/src/apis/definitions/IdentityApi.ts index 5cfc4723e0..2d29709b02 100644 --- a/packages/core-api/src/apis/definitions/IdentityApi.ts +++ b/packages/core-api/src/apis/definitions/IdentityApi.ts @@ -30,6 +30,7 @@ export type IdentityApi = { */ getUserId(): string; + // TODO: getProfile(): Promise - We want this to be async when added, but needs more work. /** * The profile of the signed in user. */ @@ -43,8 +44,6 @@ export type IdentityApi = { */ getIdToken(): Promise; - // TODO: getProfile(): Promise - We want this to be async when added, but needs more work. - /** * Sign out the current user */