Tweak JSDoc descriptions.

Author: jaydenseric

Cache.mjs

@@ -52,12 +52,12 @@ export default class Cache extends EventTarget {
  */
 
 /**
- * A unique key to access a {@link CacheValue cache value}.
+ * Unique key to access a {@link CacheValue cache value}.
  * @typedef {string} CacheKey
  */
 
 /**
- * A {@link Cache.store cache store} value. If server side rendering, it should
+ * {@link Cache.store Cache store} value. If server side rendering, it should
  * be JSON serializable for client hydration. It should contain information
  * about any errors that occurred during loading so they can be rendered, and if
  * server side rendering, be hydrated on the client.

Provider.mjs

@@ -9,7 +9,7 @@ import Loading from "./Loading.mjs";
 import LoadingContext from "./LoadingContext.mjs";
 
 /**
- * A React component to provide all the React context required to fully enable
+ * React component to provide all the React context required to fully enable
  * [`graphql-react`](https://npm.im/graphql-react) functionality:
  *
  * - {@linkcode HydrationTimeStampContext}

test/Deferred.mjs

@@ -1,7 +1,7 @@
 // @ts-check
 
 /**
- * A deferred promise that can be externally resolved or rejected.
+ * Deferred promise that can be externally resolved or rejected.
  * @template T
  */
 export default class Deferred {

types.mjs

@@ -17,7 +17,7 @@ export {};
  */
 
 /**
- * A GraphQL operation. Additional properties may be used; all are sent to the
+ * GraphQL operation. Additional properties may be used; all are sent to the
  * GraphQL server.
  * @typedef {object} GraphQLOperation
  * @prop {string} query GraphQL queries or mutations.
@@ -26,7 +26,7 @@ export {};
  */
 
 /**
- * A GraphQL result.
+ * GraphQL result.
  * @see [GraphQL spec for a response](https://spec.graphql.org/October2021/#sec-Response).
  * @template [ErrorTypes=GraphQLResultError] Possible error types.
  * @typedef {object} GraphQLResult
@@ -39,7 +39,7 @@ export {};
  */
 
 /**
- * A {@link GraphQLResult.errors GraphQL result error}.
+ * {@link GraphQLResult.errors GraphQL result error}.
  * @see [GraphQL spec for response errors](https://spec.graphql.org/October2021/#sec-Errors).
  * @template {Record<string, unknown>} [Extensions=Record<string, unknown>]
  *   Extensions to a standard GraphQL error.
@@ -53,7 +53,7 @@ export {};
  */
 
 /**
- * A {@link GraphQLResult GraphQL result} loading error generated on the client,
+ * {@link GraphQLResult GraphQL result} loading error generated on the client,
  * not the GraphQL server.
  * @template {string} Code Error code.
  * @template {Record<string, unknown>} [Extensions={}] Error specific details.

useAutoAbortLoad.mjs

@@ -6,10 +6,10 @@
 import React from "react";
 
 /**
- * A React hook to create a memoized {@link Loader loader} from
- * another, that automatically aborts previous loading that started via this
- * hook when new loading starts via this hook, the hook arguments change, or the
- * component unmounts.
+ * React hook to create a memoized {@link Loader loader} from another, that
+ * automatically aborts previous loading that started via this hook when new
+ * loading starts via this hook, the hook arguments change, or the component
+ * unmounts.
  * @param {Loader} load Memoized function that starts the loading.
  * @returns {Loader} Memoized function that starts the loading.
  */

useAutoLoad.mjs

@@ -10,7 +10,7 @@ import useLoadOnStale from "./useLoadOnStale.mjs";
 /** @typedef {import("./types.mjs").Loader} Loader */
 
 /**
- * A React hook to prevent a {@link Cache.store cache store} entry from being
+ * React hook to prevent a {@link Cache.store cache store} entry from being
  * pruned while the component is mounted and automatically keep it loaded.
  * Previous loading that started via this hook aborts when new loading starts
  * via this hook, the hook arguments change, or the component unmounts.

useCache.mjs

@@ -6,7 +6,7 @@ import Cache from "./Cache.mjs";
 import CacheContext from "./CacheContext.mjs";
 
 /**
- * A React hook to use the {@linkcode CacheContext}.
+ * React hook to use the {@linkcode CacheContext}.
  * @returns {Cache} The cache.
  */
 export default function useCache() {

useCacheEntry.mjs

@@ -9,7 +9,7 @@ import useForceUpdate from "./useForceUpdate.mjs";
 /** @typedef {import("./Cache.mjs").CacheValue} CacheValue */
 
 /**
- * A React hook to get a {@link CacheValue cache value} using its
+ * React hook to get a {@link CacheValue cache value} using its
  * {@link CacheKey cache key}.
  * @param {CacheKey} cacheKey Cache key.
  * @returns {CacheValue} Cache value, if present.

useCacheEntryPrunePrevention.mjs

@@ -7,7 +7,7 @@ import useCache from "./useCache.mjs";
 /** @typedef {import("./Cache.mjs").default} Cache */
 
 /**
- * A React hook to prevent a {@link Cache.store cache store} entry from being
+ * React hook to prevent a {@link Cache.store cache store} entry from being
  * pruned, by canceling the cache entry deletion for
  * {@link Cache#event:prune prune events} with `event.preventDefault()`.
  * @param {import("./Cache.mjs").CacheKey} cacheKey Cache key.

useForceUpdate.mjs

@@ -3,7 +3,7 @@
 import React from "react";
 
 /**
- * A React hook to force the component to update and re-render on demand.
+ * React hook to force the component to update and re-render on demand.
  * @returns {() => void} Function that forces an update.
  * @see [React hooks FAQ](https://reactjs.org/docs/hooks-faq.html#is-there-something-like-forceupdate).
  * @see [Gotcha explanation](https://github.com/CharlesStover/use-force-update/issues/18#issuecomment-554486618).