[SPARK-49371][SPARK-51086][SQL][CONNECT][DOCS] Fix various doc SQL issues. #49800
Conversation
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
HyukjinKwon
approved these changes
Feb 5, 2025
cloud-fan
reviewed
Feb 5, 2025
| .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/errors"))) | ||
| .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/errors"))) | ||
| .map(_.filterNot(_.getCanonicalPath.contains("org/apache/hive"))) | ||
| .map(_.filterNot(_.getCanonicalPath.contains("org/apache/spark/sql/v2/avro"))) |
Contributor
There was a problem hiding this comment.
shall we also exclude org.apache.spark.sql.avro?
Contributor
Author
There was a problem hiding this comment.
Well the problem is that org.apache.spark.sql.avro.functions is user facing API. I can mark the entire datasource implementation as private[sql], but I'd prefer to move it elsewhere.
Contributor
There was a problem hiding this comment.
ah I see. Yea we should move it to org.apache.spark.sql.execution.datasources.avro following other file sources.
cloud-fan
approved these changes
Feb 5, 2025
Contributor
Author
|
Merging to 4.0/master. |
asfgit
pushed a commit
that referenced
this pull request
Feb 6, 2025
…sues ### What changes were proposed in this pull request? This PR fixes a bunch of issues with SQL API docs for Scala and Java: - Removes the now defunct Connect API docs. The current SQL docs provide enough coverage. - Removes the following internal packages from the docs: `org.apache.spark.sql.artifact`, `org.apache.spark.sql.scripting`, and `org.apache.spark.sql.ml`. - Fixes the removal of the `org.apache.spark.error` and `org.apache.spark.sql.error` packages. - Marks a bunch of internal classes in the `org.apache.spark.sql` as `private[sql]` to remove them from the docs. - Moves the `TableValuedFunctionArgument` interface from `org.apache.spark.sql` to `org.apache.spark.sql.internal` because it kept showing up in the docs. ### Why are the changes needed? Readable docs are important! ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Manual inspection of the Java and Scala docs. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #49800 from hvanhovell/SPARK-49371. Authored-by: Herman van Hovell <herman@databricks.com> Signed-off-by: Herman van Hovell <herman@databricks.com> (cherry picked from commit aefaa66) Signed-off-by: Herman van Hovell <herman@databricks.com>
zifeif2
pushed a commit
to zifeif2/spark
that referenced
this pull request
Nov 14, 2025
…sues ### What changes were proposed in this pull request? This PR fixes a bunch of issues with SQL API docs for Scala and Java: - Removes the now defunct Connect API docs. The current SQL docs provide enough coverage. - Removes the following internal packages from the docs: `org.apache.spark.sql.artifact`, `org.apache.spark.sql.scripting`, and `org.apache.spark.sql.ml`. - Fixes the removal of the `org.apache.spark.error` and `org.apache.spark.sql.error` packages. - Marks a bunch of internal classes in the `org.apache.spark.sql` as `private[sql]` to remove them from the docs. - Moves the `TableValuedFunctionArgument` interface from `org.apache.spark.sql` to `org.apache.spark.sql.internal` because it kept showing up in the docs. ### Why are the changes needed? Readable docs are important! ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Manual inspection of the Java and Scala docs. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#49800 from hvanhovell/SPARK-49371. Authored-by: Herman van Hovell <herman@databricks.com> Signed-off-by: Herman van Hovell <herman@databricks.com> (cherry picked from commit 72aa207) Signed-off-by: Herman van Hovell <herman@databricks.com>
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?
This PR fixes a bunch of issues with SQL API docs for Scala and Java:
org.apache.spark.sql.artifact,org.apache.spark.sql.scripting, andorg.apache.spark.sql.ml.org.apache.spark.errorandorg.apache.spark.sql.errorpackages.org.apache.spark.sqlasprivate[sql]to remove them from the docs.TableValuedFunctionArgumentinterface fromorg.apache.spark.sqltoorg.apache.spark.sql.internalbecause it kept showing up in the docs.Why are the changes needed?
Readable docs are important!
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Manual inspection of the Java and Scala docs.
Was this patch authored or co-authored using generative AI tooling?
No.