vanzin commented on a change in pull request #24901: [SPARK-28091[CORE] Extend 
Spark metrics system with user-defined metrics using executor plugins
URL: https://github.com/apache/spark/pull/24901#discussion_r321900749
 
 

 ##########
 File path: core/src/main/java/org/apache/spark/ExecutorPlugin.java
 ##########
 @@ -40,12 +40,16 @@
    * Initialize the executor plugin.
    *
    * <p>Each executor will, during its initialization, invoke this method on 
each
-   * plugin provided in the spark.executor.plugins configuration.</p>
+   * plugin provided in the spark.executor.plugins configuration. The Spark 
executor
+   * will wait on the completion of the execution of the init method.</p>
    *
    * <p>Plugins should create threads in their implementation of this method 
for
    * any polling, blocking, or intensive computation.</p>
+   *
+   * @param pluginContext The user-supplied init method for this class is 
initialized
 
 Review comment:
   The description of the parameter is redundant: we know it's a parameter to 
the init method; this is *the* documentation for that method. This should 
instead describe what that parameter is (e.g. "context information for the 
executor where the plugin is running").

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


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to