fix: correct comments

grpc · Nov 6, 2019 · 821c9ab · 821c9ab
1 parent 5f271de
commit 821c9ab
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/packages/grpc-js/src/subchannel-pool.ts b/packages/grpc-js/src/subchannel-pool.ts
@@ -51,9 +51,8 @@ export class SubchannelPool {
   constructor(private global: boolean) {}
 
   /**
-   * Unrefs all unused subchannels.
-   * 
-   * @returns `true` if all subchannels have been unrefed. `false` otherwise.
+   * Unrefs all unused subchannels and cancels the cleanup task if all
+   * subchannels have been unrefed.
    */
   unrefUnusedSubchannels(): void {
     let allSubchannelsUnrefed = true;
@@ -93,7 +92,7 @@ export class SubchannelPool {
   }
 
   /**
-   * Ensure that the cleanup task is spawned.
+   * Ensures that the cleanup task is spawned.
    */
   ensureCleanupTask(): void {
     if (this.global && this.cleanupTimer === undefined) {