Github user HyukjinKwon commented on a diff in the pull request:
https://github.com/apache/spark/pull/16137#discussion_r91010077
--- Diff: core/src/main/scala/org/apache/spark/SparkContext.scala ---
@@ -1417,27 +1551,31 @@ class SparkContext(config: SparkConf) extends
Logging {
/**
* Add a file to be downloaded with this Spark job on every node.
- * The `path` passed can be either a local file, a file in HDFS (or
other Hadoop-supported
- * filesystems), or an HTTP, HTTPS or FTP URI. To access the file in
Spark jobs,
- * use `SparkFiles.get(fileName)` to find its download location.
+ *
+ * @param path can be either a local file, a file in HDFS (or other
Hadoop-supported
+ * filesystems), or an HTTP, HTTPS or FTP URI. To access
the file in Spark jobs,
+ * use `SparkFiles.get(fileName)` to find its download
location.
*/
def addFile(path: String): Unit = {
addFile(path, false)
}
/**
- * Returns a list of file paths that are added to resources.
+ * A list of file paths that are added to resources.
--- End diff --
For me, I personally think we just better leave them or duplicate the
description into `@return`. I think I am not supposed to decide this. cc
@srowen.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
