GitHub user HyukjinKwon opened a pull request:
https://github.com/apache/spark/pull/15889
[WIP][SPARK-18445][DOCS] Fix the markdown for `Note:`/`NOTE:`/`Note that`
across Scala/Java API documentation
## What changes were proposed in this pull request?
It seems in Scala/Java,
- `Note:`
- `NOTE:`
- `Note that`
- `'''Note:'''`
are used in a mixed way. The last one seems correct as it marks down
correctly. This will, for example, mark down it pretty, for example,
[hadoopFile(...)](http://spark.apache.org/docs/latest/api/scala/index.html#org.apache.spark.SparkContext@hadoopFile[K,V,F<:org.apache.hadoop.mapred.InputFormat[K,V]](path:String,minPartitions:Int)(implicitkm:scala.reflect.ClassTag[K],implicitvm:scala.reflect.ClassTag[V],implicitfm:scala.reflect.ClassTag[F]):org.apache.spark.rdd.RDD[(K,V)]).
Also, it seems some `'''Note:'''` s are wrongly placed, for example,
[hadoopRDD(...)](http://spark.apache.org/docs/latest/api/scala/index.html#org.apache.spark.SparkContext@hadoopRDD[K,V](conf:org.apache.hadoop.mapred.JobConf,inputFormatClass:Class[_<:org.apache.hadoop.mapred.InputFormat[K,V]],keyClass:Class[K],valueClass:Class[V],minPartitions:Int):org.apache.spark.rdd.RDD[(K,V)])
which looks like the `Note:` for the last argument (I believe it meant to be
for the API).
## How was this patch tested?
N/A
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/HyukjinKwon/spark SPARK-18437
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/15889.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #15889
----
commit 11f71017bcabb31cb5f4d9ee8048bfd2ec33b957
Author: hyukjinkwon <[email protected]>
Date: 2016-11-15T09:45:47Z
Clean up Note: to '''Note:'''
commit b9dbd9be2429985250ceefa950bc1b2002146f76
Author: hyukjinkwon <[email protected]>
Date: 2016-11-15T09:57:32Z
Clean up NOTE: to '''Note:'''
commit 0e9b3f3efe25893c8b703b534ea6a93f5cd69d39
Author: hyukjinkwon <[email protected]>
Date: 2016-11-15T10:52:52Z
Clean up Note that to '''Note:'''
commit 2acb56f46953b669afa120ad87613fe58bc2e9ca
Author: hyukjinkwon <[email protected]>
Date: 2016-11-15T11:15:54Z
Fix Java ones too
----
---
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]
