GitHub user HyukjinKwon opened a pull request:
https://github.com/apache/spark/pull/18749
[WIP][SPARK-21485][FOLLOWUP][SQL][DOCS] Describes examples and arguments
separately with note/since in SQL built-in function documentation
## What changes were proposed in this pull request?
This PR proposes to separate `extended` into `examples` and `arguments`
internally so that both can be separately documented and add `since` and `note`
for additional information.
For `since`, it looks users sometimes get confused by, up to my knowledge,
missing version information. For example, see
https://www.mail-archive.com/[email protected]/msg64798.html
For few good examples to check the built documentation, please see both:
`from_json` - https://spark-test.github.io/sparksqldoc/#from_json
`rlike` - https://spark-test.github.io/sparksqldoc/#like
For `DESCRIBE FUNCTION`, `note` and `since` are added as below:
```
> DESCRIBE FUNCTION EXTENDED rlike;
...
Extended Usage:
Arguments:
...
Examples:
...
Note:
Use LIKE to match with simple string pattern
```
```
> DESCRIBE FUNCTION EXTENDED to_json;
...
Examples:
...
Since: 2.2.0
```
For the complete documentation, see
https://spark-test.github.io/sparksqldoc/
## How was this patch tested?
Manual tests and existing tests. Please see
https://spark-test.github.io/sparksqldoc
Jenkins tests are needed to double check
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/HyukjinKwon/spark followup-sql-doc-gen
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/18749.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 #18749
----
commit 7a67b737a5295d40c5b14bb97c47e7cda67b755b
Author: hyukjinkwon <[email protected]>
Date: 2017-07-27T05:08:56Z
Restructure expression description info
commit 0958c0bd2c50009836004b3b07319131506cc245
Author: hyukjinkwon <[email protected]>
Date: 2017-07-27T08:55:22Z
Fix script and few minor cleanup
----
---
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]
