GitHub user liancheng opened a pull request:
https://github.com/apache/spark/pull/10039
[SPARK-12046] [DOC] [1.6] ScalaDoc and JavaDoc fixes
This PR fixes several issues in our Scala and Java API doc.
- Hides `spark.memory` package
- Hides `spark.examples` package
- Fixes ScalaDoc unordered list format through out the code base
Unordoreed list in ScalaDoc requires an extra space before `-` or `*`,
i.e.:
```scala
/**
* A list:
*
* - Item 1
* - Item 2
*/
```
rather than
```scala
/**
* A list:
*
* - Item 1
* - Item 2
*/
```
Otherwise the list won't be properly rendered.
- Some other minor formatting issues
Remaining issues that I haven't figured out a proper fix:
- `:: DeveloperApi ::` badge is not rendered properly on my local machine,
but not sure whether it's an environmental issue.
- `akka` package still appears in ScalaDoc root package page, even though
it's already filtered in `SparkBuild.scala`.
- Seems that most stuff in `spark.util` shouldn't be public, e.g.
- `RpcUtils`
- `InnerClosureFinder`
But they've been there for a long time. Not sure whether they are already
considered as part of the public API?
- `KinesisUtilsPythonHelper` shows up even it's marked as private
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/liancheng/spark spark-12046.doc-fix
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/10039.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 #10039
----
commit 81d973bfe3efa6a57e0fb9977b51eb66e7c1f3cb
Author: Cheng Lian <[email protected]>
Date: 2015-11-30T10:03:35Z
Fixes various ScalaDoc/JavaDoc issues
----
---
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]
