[core-amqp] improve doc comment for AcquireLockProperties.abortSignal (…

…#15417)
Azure · Jun 4, 2021 · 5b401ee · 5b401ee
1 parent 690117e
commit 5b401ee
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/sdk/core/core-amqp/src/util/lock.ts b/sdk/core/core-amqp/src/util/lock.ts
@@ -12,6 +12,8 @@ import { logger } from "../log";
 export interface AcquireLockProperties {
   /**
    * An implementation of the `AbortSignalLike` interface to signal the request to cancel lock acquisition.
+   * This only applies to the acquisition of a lock. Once the lock is acquired, the task is invoked and `acquire`
+   * can no longer be cancelled.
    * This does not cancel running the task passed to `acquire()` if the lock has been acquired,
    * but will prevent it from running if cancelled before the task is invoked.
    */