flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From shaoxuan-wang <...@git.apache.org>
Subject [GitHub] flink pull request #4546: [FLINK-6751] [docs] Add missing documentation for ...
Date Tue, 15 Aug 2017 16:04:36 GMT
GitHub user shaoxuan-wang opened a pull request:

    https://github.com/apache/flink/pull/4546

    [FLINK-6751] [docs] Add missing documentation for User-Defined Functions Page

    
    *Thank you very much for contributing to Apache Flink - we are happy that you want to
help us improve Flink. To help the community review your contribution in the best possible
way, please go through the checklist below, which will get the contribution into a shape in
which it can be best reviewed.*
    
    *Please understand that we do not do this to make contributions to Flink a hassle. In
order to uphold a high standard of quality for code contributions, while at the same time
managing a large number of contributions, we need contributors to prepare the contributions
well, and give reviewers enough contextual information for the review. Please also understand
that contributions that do not follow this guide will take longer to review and thus typically
be picked up with lower priority by the community.*
    
    ## Contribution Checklist
    
      - Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues).
Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
    
      - Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request",
where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you
are unsure about which is the best component.
      Typo fixes that have no associated JIRA issue should be named following this pattern:
`[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc
for PuncuatedWatermarkGenerator`.
    
      - Fill out the template below to describe the changes contributed by the pull request.
That will give reviewers the context they need to do the review.
    
      - Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes.
You can set up Travis CI to do that following [this guide](http://flink.apache.org/contribute-code.html#best-practices).
    
      - Each pull request should address only one issue, not mix up code from multiple issues.
    
      - Each commit in the pull request has a meaningful commit message (including the JIRA
id)
    
      - Once all items of the checklist are addressed, remove the above text and this checklist,
leaving only the filled out template below.
    
    **(The sections below can be removed for hotfixes of typos)**
    
    ## What is the purpose of the change
      - add missing (TODO) documentation for user-defined functions page
    
    ## Brief change log
      - add missing (TODO) documentation for user-defined functions page
      - a typo fix in udagg comment
    
    ## Verifying this change
    -the documentation part has been manually verified by build_docs.sh
    
    ## Does this pull request potentially affect one of the following parts:
      - Dependencies (does it add or upgrade a dependency): (no)
      - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: ( no)
      - The serializers: (no)
      - The runtime per-record code paths (performance sensitive): (no)
      - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing,
Yarn/Mesos, ZooKeeper: (no)
    
    ## Documentation
      - Does this pull request introduce a new feature? ( no)
      - If yes, how is the feature documented? (not applicable)

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/shaoxuan-wang/flink F6751-submit

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/4546.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 #4546
    
----
commit 6c253dba072fc21f480588b89c92688eb8da597d
Author: shaoxuan-wang <shaoxuan@apache.org>
Date:   2017-08-15T16:00:12Z

    [FLINK-6751] [docs] Add missing documentation for User-Defined Functions Page

----


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message