[SPARK-16111][SQL][DOC] Hide SparkOrcNewRecordReader in API docs#13914
Closed
dongjoon-hyun wants to merge 2 commits intoapache:masterfrom
dongjoon-hyun:SPARK-16111
Closed
[SPARK-16111][SQL][DOC] Hide SparkOrcNewRecordReader in API docs#13914dongjoon-hyun wants to merge 2 commits intoapache:masterfrom dongjoon-hyun:SPARK-16111
dongjoon-hyun wants to merge 2 commits intoapache:masterfrom
dongjoon-hyun:SPARK-16111
Conversation
project/SparkBuild.scala
Outdated
| // Skip class names containing $ and some internal packages in Javadocs | ||
| unidocAllSources in (JavaUnidoc, unidoc) := { | ||
| ignoreUndocumentedPackages((unidocAllSources in (JavaUnidoc, unidoc)).value) | ||
| .map(_.filterNot(_.getCanonicalPath.contains("org/apache/hadoop/hive/ql/io/orc"))) |
Member
Author
There was a problem hiding this comment.
We can exclude the org.apache.hadoop.hive.ql.io.orc package from Javadoc in this way like the other exclusions.
Contributor
There was a problem hiding this comment.
i'd exclude everything in org/apache/hadoop?
Member
Author
There was a problem hiding this comment.
Thank you for review, @rxin . :)
Sure. I'll update it.
Member
Author
|
Hi, @mengxr . |
dongjoon-hyun
changed the title
|
Test build #61267 has finished for PR 13914 at commit
|
Member
Author
|
Hi, @mengxr . |
|
Test build #61339 has finished for PR 13914 at commit
|
Contributor
|
Merging in master/2.0. |
asfgit
pushed a commit
that referenced
this pull request
Jun 28, 2016
## What changes were proposed in this pull request? Currently, Spark Scala/Java API documents shows **org.apache.hadoop.hive.ql.io.orc** package at the top. http://spark.apache.org/docs/2.0.0-preview/api/scala/index.html#org.apache.spark.package http://spark.apache.org/docs/2.0.0-preview/api/java/index.html This PR hides `SparkOrcNewRecordReader` from API docs. ## How was this patch tested? Manual. (`build/sbt unidoc`). The following is the screenshot after this PR. **Scala API doc**  **Java API doc**  Author: Dongjoon Hyun <dongjoon@apache.org> Closes #13914 from dongjoon-hyun/SPARK-16111. (cherry picked from commit 50fdd86) Signed-off-by: Reynold Xin <rxin@databricks.com>
Member
Author
|
Thank you for merging, @rxin . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Currently, Spark Scala/Java API documents shows org.apache.hadoop.hive.ql.io.orc package at the top.
http://spark.apache.org/docs/2.0.0-preview/api/scala/index.html#org.apache.spark.package
http://spark.apache.org/docs/2.0.0-preview/api/java/index.html
This PR hides
SparkOrcNewRecordReaderfrom API docs.How was this patch tested?
Manual. (
build/sbt unidoc).The following is the screenshot after this PR.
Scala API doc
Java API doc