documentation: fix link to isInUseLocksError (#7394)

Co-authored-by: Ben Polinsky <ben-polinsky@users.noreply.github.com> (cherry picked from commit 5e617a5)
iTwin · Nov 18, 2024 · 6e9c514 · 6e9c514
1 parent 5655675
commit 6e9c514
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/common/changes/@itwin/core-common/docs-isInUseLocksError-link-fix_2024-11-18-19-36.json b/common/changes/@itwin/core-common/docs-isInUseLocksError-link-fix_2024-11-18-19-36.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-common",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-common"
+}
diff --git a/core/common/src/ITwinError.ts b/core/common/src/ITwinError.ts
@@ -72,7 +72,7 @@ export namespace InUseLocksError {
     return ITwinError.isITwinError(error) && error.namespace === "itwinjs-core" && error.errorKey === "in-use-locks";
   }
 
-  /** throws an error which passes the [[isInUseLocksError]] type guard function */
+  /** throws an error which passes the [[InUseLocksError.isInUseLocksError]] type guard function */
   export function throwInUseLocksError(inUseLocks: InUseLock[], message?: string, metadata?: LoggingMetaData): never {
     const errorObject = new Error();
     errorObject.name = "InUseLocksError"; // optional but makes it so that when the error is thrown and not caught we see InUseLocksError: 'message' instead of Error: 'message'