diff options
| author | hyukjinkwon <gurwls223@gmail.com> | 2016-11-19 11:24:15 +0000 |
|---|---|---|
| committer | Sean Owen <sowen@cloudera.com> | 2016-11-19 11:24:15 +0000 |
| commit | d5b1d5fc80153571c308130833d0c0774de62c92 (patch) | |
| tree | a194c154699e2edb55c146232c66251d4ac77f18 /pom.xml | |
| parent | db9fb9baacbf8640dd37a507b7450db727c7e6ea (diff) | |
| download | spark-d5b1d5fc80153571c308130833d0c0774de62c92.tar.gz spark-d5b1d5fc80153571c308130833d0c0774de62c92.tar.bz2 spark-d5b1d5fc80153571c308130833d0c0774de62c92.zip | |
[SPARK-18445][BUILD][DOCS] Fix the markdown for `Note:`/`NOTE:`/`Note that`/`'''Note:'''` across Scala/Java API documentation
## What changes were proposed in this pull request?
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
## How was this patch tested?
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.
Diffstat (limited to 'pom.xml')
| -rw-r--r-- | pom.xml | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -2476,6 +2476,13 @@ <artifactId>maven-javadoc-plugin</artifactId> <configuration> <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam> + <tags> + <tag> + <name>note</name> + <placement>a</placement> + <head>Note:</head> + </tag> + </tags> </configuration> </plugin> </plugins> |