[SPARK-28805][DOCS][SQL] Document DESCRIBE FUNCTION in SQL Reference #25530
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
|
Test build #109474 has finished for PR 25530 at commit
|
Contributor
Author
|
cc @gatorsmile |
srowen
requested changes
Aug 21, 2019
| **This page is under construction** | ||
| Return the metadata such as qualified function name, implementing class and usage of an existing function. | ||
| Input parameter function name may be optionally qualified. If the function is not qualified then the function is | ||
| resolved from the current database. If EXTENDED option is specified then additionally extended usage information |
Member
There was a problem hiding this comment.
Back-tick EXTENDED, and add "the" before.
Contributor
Author
There was a problem hiding this comment.
@srowen Changed. Sean, i also backticked the function_name. Is that ok ?
|
Test build #109513 has finished for PR 25530 at commit
|
dilipbiswal
changed the title
dilipbiswal
force-pushed
the
ref-doc-desc-function
branch
from
964aa71 to
9a4db23
Compare
|
Test build #110030 has finished for PR 25530 at commit
|
Member
|
LGTM Thanks! Merged to master. |
Contributor
Author
|
@gatorsmile Thank you very much for fixing the mistakes and merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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?
Document DESCRIBE FUNCTION statement in SQL Reference Guide.
Why are the changes needed?
Currently Spark lacks documentation on the supported SQL constructs causing
confusion among users who sometimes have to look at the code to understand the
usage. This is aimed at addressing this issue.
Does this PR introduce any user-facing change?
Yes.
Before:
There was no documentation for this.
After.
How was this patch tested?
Tested using jykyll build --serve