[SPARK-42987][DOCS] Correction of protobuf sql documentation #40614
+34
−46
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
lucaspompeun
changed the title
lucaspompeun
changed the title
Contributor
Author
|
I'have corrected the problem that cause build error in github workflow |
Member
|
cc @SandishKumarHN and @rangadi |
rangadi
approved these changes
Apr 3, 2023
There was a problem hiding this comment.
Thanks for the updates Lucas.
This looks great.
A few more fixes if you could:
- add two space indentation for code sample (first screenshot)
- Replace comment string
First, via the protobuf descriptor file, and then via the protobuf message class name.withVia Protobuf descriptor file, or via shaded Java class - In SQL Type conversion table:
- Add one more row :
Anymaps toStructType
- Add one more row :
Contributor
Author
|
@rangadi The adition of |
Contributor
Author
|
@rangadi the first two fixes were made |
|
@lucaspompeun thanks for the updates. LGTM.
|
Contributor
Author
|
@rangadi Done! |
|
Thanks. |
HyukjinKwon
approved these changes
Apr 10, 2023
Member
|
Merged to master. |
yaooqinn
added a commit
that referenced
this pull request
Oct 13, 2023
### What changes were proposed in this pull request? This PR restores the [Protobuf Data Source Guide](https://spark.apache.org/docs/latest/sql-data-sources-protobuf.html#python)'s code tabs which #40614 removed for markdown syntax fixes In this PR, we introduce a hidden div to hold the code-block marker of markdown, then make both the liquid and markdown happy. ### Why are the changes needed? improve doc readability and consistency. ### Does this PR introduce _any_ user-facing change? yes, doc change ### How was this patch tested? #### Doc build  #### markdown editor and view  ### Was this patch authored or co-authored using generative AI tooling? no Closes #43361 from yaooqinn/SPARK-45532. Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Kent Yao <yao@apache.org>
yaooqinn
added a commit
that referenced
this pull request
Oct 13, 2023
### What changes were proposed in this pull request? This PR restores the [Protobuf Data Source Guide](https://spark.apache.org/docs/latest/sql-data-sources-protobuf.html#python)'s code tabs which #40614 removed for markdown syntax fixes In this PR, we introduce a hidden div to hold the code-block marker of markdown, then make both the liquid and markdown happy. ### Why are the changes needed? improve doc readability and consistency. ### Does this PR introduce _any_ user-facing change? yes, doc change ### How was this patch tested? #### Doc build  #### markdown editor and view  ### Was this patch authored or co-authored using generative AI tooling? no Closes #43361 from yaooqinn/SPARK-45532. Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Kent Yao <yao@apache.org> (cherry picked from commit 0257b77) Signed-off-by: Kent Yao <yao@apache.org>
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?
Correction of code highlights in SQL protobuf documentation.
old version:
new version:
Why are the changes needed?
To help spark users to understand python, scala and java code examples.
Does this PR introduce any user-facing change?
Yes, it improve user-facing documentation
How was this patch tested?
Comparing visual structure in the old and the new version in vscode markdown preview and github markdown preview.