[incubator-openwhisk] branch master updated: Use method links and correct method name. (#3695)

[du...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dubeejw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk.git


The following commit(s) were added to refs/heads/master by this push:
     new 6a5ef98  Use method links and correct method name. (#3695)
6a5ef98 is described below

commit 6a5ef98d80c5b1f857ef8baaef93b522662a88ef
Author: rodric rabbah <ro...@gmail.com>
AuthorDate: Thu May 24 12:49:53 2018 -0400

    Use method links and correct method name. (#3695)
---
 .../whisk/core/loadBalancer/ShardingContainerPoolBalancer.scala  | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/core/controller/src/main/scala/whisk/core/loadBalancer/ShardingContainerPoolBalancer.scala b/core/controller/src/main/scala/whisk/core/loadBalancer/ShardingContainerPoolBalancer.scala
index e99b972..7e817e7 100644
--- a/core/controller/src/main/scala/whisk/core/loadBalancer/ShardingContainerPoolBalancer.scala
+++ b/core/controller/src/main/scala/whisk/core/loadBalancer/ShardingContainerPoolBalancer.scala
@@ -84,8 +84,9 @@ class ShardingContainerPoolBalancer(config: WhiskConfig, controllerInstance: Ins
   /**
    * Monitors invoker supervision and the cluster to update the state sequentially
    *
-   * All state updates should go through this actor to guarantee, that `updateState` and `updateCluster` are called
-   * mutually exclusive and not concurrently.
+   * All state updates should go through this actor to guarantee that
+   * [[ShardingContainerPoolBalancerState.updateInvokers]] and [[ShardingContainerPoolBalancerState.updateCluster]]
+   * are called exclusive of each other and not concurrently.
    */
   private val monitor = actorSystem.actorOf(Props(new Actor {
     override def preStart(): Unit = {
@@ -417,7 +418,7 @@ case class ShardingContainerPoolBalancerState(
    * Handling a shrinking invokers list is not necessary, because InvokerPool won't shrink its own list but rather
    * report the invoker as "Offline".
    *
-   * It is important that this method does not run concurrently to itself and/or to `updateCluster`
+   * It is important that this method does not run concurrently to itself and/or to [[updateCluster]]
    */
   def updateInvokers(newInvokers: IndexedSeq[InvokerHealth]): Unit = {
     val oldSize = _invokers.size
@@ -454,7 +455,7 @@ case class ShardingContainerPoolBalancerState(
    * This is okay to not happen atomically, since a dirty read of the values set are not dangerous. At worst the
    * scheduler works on outdated invoker-load data which is acceptable.
    *
-   * It is important that this method does not run concurrently to itself and/or to `updateState`
+   * It is important that this method does not run concurrently to itself and/or to [[updateInvokers]]
    */
   def updateCluster(newSize: Int): Unit = {
     val actualSize = newSize max 1 // if a cluster size < 1 is reported, falls back to a size of 1 (alone)

-- 
To stop receiving notification emails like this one, please contact
dubeejw@apache.org.