[GitHub] dubee closed pull request #3695: Use method links and correct method name.

[GitBox <gi...@apache.org>]

dubee closed pull request #3695: Use method links and correct method name.
URL: https://github.com/apache/incubator-openwhisk/pull/3695
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

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 e99b972678..7e817e7411 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)


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services