-
- Downloads
[SPARK-18445][BUILD][DOCS] Fix the markdown for `Note:`/`NOTE:`/`Note...
[SPARK-18445][BUILD][DOCS] Fix the markdown for `Note:`/`NOTE:`/`Note that`/`'''Note:'''` across Scala/Java API documentation It seems in Scala/Java, - `Note:` - `NOTE:` - `Note that` - `'''Note:'''` - `note` This PR proposes to fix those to `note` to be consistent. **Before** - Scala  - Java  **After** - Scala  - Java  The notes were found via ```bash grep -r "NOTE: " . | \ # Note:|NOTE:|Note that|'''Note:''' grep -v "// NOTE: " | \ # starting with // does not appear in API documentation. grep -E '.scala|.java' | \ # java/scala files grep -v Suite | \ # exclude tests grep -v Test | \ # exclude tests grep -e 'org.apache.spark.api.java' \ # packages appear in API documenation -e 'org.apache.spark.api.java.function' \ # note that this is a regular expression. So actual matches were mostly `org/apache/spark/api/java/functions ...` -e 'org.apache.spark.api.r' \ ... ``` ```bash grep -r "Note that " . | \ # Note:|NOTE:|Note that|'''Note:''' grep -v "// Note that " | \ # starting with // does not appear in API documentation. grep -E '.scala|.java' | \ # java/scala files grep -v Suite | \ # exclude tests grep -v Test | \ # exclude tests grep -e 'org.apache.spark.api.java' \ # packages appear in API documenation -e 'org.apache.spark.api.java.function' \ -e 'org.apache.spark.api.r' \ ... ``` ```bash grep -r "Note: " . | \ # Note:|NOTE:|Note that|'''Note:''' grep -v "// Note: " | \ # starting with // does not appear in API documentation. grep -E '.scala|.java' | \ # java/scala files grep -v Suite | \ # exclude tests grep -v Test | \ # exclude tests grep -e 'org.apache.spark.api.java' \ # packages appear in API documenation -e 'org.apache.spark.api.java.function' \ -e 'org.apache.spark.api.r' \ ... ``` ```bash grep -r "'''Note:'''" . | \ # Note:|NOTE:|Note that|'''Note:''' grep -v "// '''Note:''' " | \ # starting with // does not appear in API documentation. grep -E '.scala|.java' | \ # java/scala files grep -v Suite | \ # exclude tests grep -v Test | \ # exclude tests grep -e 'org.apache.spark.api.java' \ # packages appear in API documenation -e 'org.apache.spark.api.java.function' \ -e 'org.apache.spark.api.r' \ ... ``` And then fixed one by one comparing with API documentation/access modifiers. After that, manually tested via `jekyll build`. Author: hyukjinkwon <gurwls223@gmail.com> Closes #15889 from HyukjinKwon/SPARK-18437. (cherry picked from commit d5b1d5fc) Signed-off-by:Sean Owen <sowen@cloudera.com>
Showing
- core/src/main/scala/org/apache/spark/ContextCleaner.scala 1 addition, 1 deletioncore/src/main/scala/org/apache/spark/ContextCleaner.scala
- core/src/main/scala/org/apache/spark/Partitioner.scala 1 addition, 1 deletioncore/src/main/scala/org/apache/spark/Partitioner.scala
- core/src/main/scala/org/apache/spark/SparkConf.scala 3 additions, 3 deletionscore/src/main/scala/org/apache/spark/SparkConf.scala
- core/src/main/scala/org/apache/spark/SparkContext.scala 25 additions, 22 deletionscore/src/main/scala/org/apache/spark/SparkContext.scala
- core/src/main/scala/org/apache/spark/api/java/JavaDoubleRDD.scala 2 additions, 2 deletions.../main/scala/org/apache/spark/api/java/JavaDoubleRDD.scala
- core/src/main/scala/org/apache/spark/api/java/JavaPairRDD.scala 16 additions, 10 deletions...rc/main/scala/org/apache/spark/api/java/JavaPairRDD.scala
- core/src/main/scala/org/apache/spark/api/java/JavaRDD.scala 7 additions, 5 deletionscore/src/main/scala/org/apache/spark/api/java/JavaRDD.scala
- core/src/main/scala/org/apache/spark/api/java/JavaRDDLike.scala 2 additions, 1 deletion...rc/main/scala/org/apache/spark/api/java/JavaRDDLike.scala
- core/src/main/scala/org/apache/spark/api/java/JavaSparkContext.scala 11 additions, 10 deletions...in/scala/org/apache/spark/api/java/JavaSparkContext.scala
- core/src/main/scala/org/apache/spark/api/java/JavaSparkStatusTracker.scala 1 addition, 1 deletion...la/org/apache/spark/api/java/JavaSparkStatusTracker.scala
- core/src/main/scala/org/apache/spark/io/CompressionCodec.scala 11 additions, 12 deletions...src/main/scala/org/apache/spark/io/CompressionCodec.scala
- core/src/main/scala/org/apache/spark/partial/BoundedDouble.scala 1 addition, 1 deletion...c/main/scala/org/apache/spark/partial/BoundedDouble.scala
- core/src/main/scala/org/apache/spark/rdd/CoGroupedRDD.scala 4 additions, 4 deletionscore/src/main/scala/org/apache/spark/rdd/CoGroupedRDD.scala
- core/src/main/scala/org/apache/spark/rdd/DoubleRDDFunctions.scala 1 addition, 1 deletion.../main/scala/org/apache/spark/rdd/DoubleRDDFunctions.scala
- core/src/main/scala/org/apache/spark/rdd/HadoopRDD.scala 3 additions, 3 deletionscore/src/main/scala/org/apache/spark/rdd/HadoopRDD.scala
- core/src/main/scala/org/apache/spark/rdd/NewHadoopRDD.scala 3 additions, 3 deletionscore/src/main/scala/org/apache/spark/rdd/NewHadoopRDD.scala
- core/src/main/scala/org/apache/spark/rdd/PairRDDFunctions.scala 13 additions, 10 deletions...rc/main/scala/org/apache/spark/rdd/PairRDDFunctions.scala
- core/src/main/scala/org/apache/spark/rdd/PartitionPruningRDD.scala 1 addition, 1 deletion...main/scala/org/apache/spark/rdd/PartitionPruningRDD.scala
- core/src/main/scala/org/apache/spark/rdd/PartitionwiseSampledRDD.scala 1 addition, 1 deletion.../scala/org/apache/spark/rdd/PartitionwiseSampledRDD.scala
- core/src/main/scala/org/apache/spark/rdd/RDD.scala 23 additions, 23 deletionscore/src/main/scala/org/apache/spark/rdd/RDD.scala
Loading
Please register or sign in to comment