Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-4203] [table] [docs] Improve Table API documentation #2293

Closed
wants to merge 1 commit into from

Conversation

twalthr
Copy link
Contributor

@twalthr twalthr commented Jul 25, 2016

Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the How To Contribute guide.
In addition to going through the list, please provide a meaningful description of your changes.

  • General
    • The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
    • The pull request addresses only one issue
    • Each commit in the PR has a meaningful commit message (including the JIRA id)
  • Documentation
    • Documentation has been added for new functionality
    • Old documentation affected by the pull request has been updated
    • JavaDoc for public methods has been added
  • Tests & Build
    • Functionality added by the pull request is covered by tests
    • mvn clean verify has been executed successfully locally or a Travis build has passed

This PR improves the documentation of the Table API a bit. It adds...

  • Reserved Keywords
  • Description of built-in Scalar Functions
  • SQL BNF grammar
  • Description of types
  • Small fixes

There was also a "substring()" documentation mistake that is corrected in this PR.

@twalthr
Copy link
Contributor Author

twalthr commented Aug 2, 2016

I will merge this now. The doc is still not perfect but we can further improve it in the future.

@asfgit asfgit closed this in 3f1e8b9 Aug 2, 2016
delding pushed a commit to delding/flink that referenced this pull request Aug 2, 2016
hequn8128 pushed a commit to hequn8128/flink that referenced this pull request Jun 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants