You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by raymondtay <gi...@git.apache.org> on 2017/09/13 03:22:28 UTC
[GitHub] flink pull request #4666: [FLINK-7613][Documentation] Fixed typographical er...
GitHub user raymondtay opened a pull request:
https://github.com/apache/flink/pull/4666
[FLINK-7613][Documentation] Fixed typographical error
*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
*(For example: This pull request makes task deployment go through the blob server, rather than through RPC. That way we avoid re-transferring them on each deployment (during recovery).)*
## Brief change log
*(for example:)*
- *The TaskInfo is stored in the blob store on job creation time as a persistent artifact*
- *Deployments RPC transmits only the blob storage reference*
- *TaskManagers retrieve the TaskInfo from the blob cache*
## Verifying this change
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (100MB)*
- *Extended integration test for recovery after master (JobManager) failure*
- *Added test that validates that TaskInfo is transferred only once across recoveries*
- *Manually verified the change by running a 4 node cluser with 2 JobManagers and 4 TaskManagers, a stateful streaming program, and killing one JobManager and two TaskManagers during the execution, verifying that recovery happens correctly.*
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (yes / no)
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes / no)
- The serializers: (yes / no / don't know)
- The runtime per-record code paths (performance sensitive): (yes / no / don't know)
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (yes / no / don't know)
## Documentation
- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/raymondtay/flink master
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4666.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 #4666
----
commit 9e4e5a2efab4d50c498e9a4bd0710c9388822673
Author: Raymond Tay <ra...@gmail.com>
Date: 2017-09-13T03:21:17Z
[FLINK-7613] Fixed typographical error
----
---
[GitHub] flink pull request #4666: [FLINK-7613][Documentation] Fixed typographical er...
Posted by raymondtay <gi...@git.apache.org>.
Github user raymondtay commented on a diff in the pull request:
https://github.com/apache/flink/pull/4666#discussion_r139849283
--- Diff: docs/dev/datastream_api.md ---
@@ -497,7 +497,9 @@ env.generateSequence(1,10).map(new MyMapper()).setBufferTimeout(timeoutMillis);
LocalStreamEnvironment env = StreamExecutionEnvironment.createLocalEnvironment
env.setBufferTimeout(timeoutMillis)
-env.genereateSequence(1,10).map(myMap).setBufferTimeout(timeoutMillis)
+def myMap : Long => Long = _ + 1 // `generateSequence` returns a `DataStream[Long]` type
--- End diff --
I'm taking the perspective of the absolute beginner since this doc was linked from the QuickStart section; when i started with the QuickStart section most parts of the doc were good enough (imo) to guide me w/o referring to the javadocs (which i think makes perfect sense) so i thought it might be a good idea to continue this tradition and make things explicitly clear. What do you think @zentol ?
---
[GitHub] flink issue #4666: [FLINK-7613][Documentation] Fixed typographical error
Posted by yew1eb <gi...@git.apache.org>.
Github user yew1eb commented on the issue:
https://github.com/apache/flink/pull/4666
LGTM
---
[GitHub] flink issue #4666: [FLINK-7613][Documentation] Fixed typographical error
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on the issue:
https://github.com/apache/flink/pull/4666
@raymondtay are we still looking to make this change? Defining the mapper may be just as likely to confuse new Flink users.
Also, when updating future PRs you want to rebase to master rather than merging master.
---
[GitHub] flink pull request #4666: [FLINK-7613][Documentation] Fixed typographical er...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4666#discussion_r139635191
--- Diff: docs/dev/execution_configuration.md ---
@@ -42,44 +42,44 @@ var executionConfig = env.getConfig
The following configuration options are available: (the default is bold)
-- **`enableClosureCleaner()`** / `disableClosureCleaner()`. The closure cleaner is enabled by default. The closure cleaner removes unneeded references to the surrounding class of anonymous functions inside Flink programs.
+- **`enableClosureCleaner()`** / **`disableClosureCleaner()`**. The closure cleaner is enabled by default. The closure cleaner removes unneeded references to the surrounding class of anonymous functions inside Flink programs.
--- End diff --
As noted just above the list, the bold option specifies what the default is, we we're losing information here.
---
[GitHub] flink pull request #4666: [FLINK-7613][Documentation] Fixed typographical er...
Posted by raymondtay <gi...@git.apache.org>.
Github user raymondtay commented on a diff in the pull request:
https://github.com/apache/flink/pull/4666#discussion_r139848500
--- Diff: docs/dev/execution_configuration.md ---
@@ -42,44 +42,44 @@ var executionConfig = env.getConfig
The following configuration options are available: (the default is bold)
-- **`enableClosureCleaner()`** / `disableClosureCleaner()`. The closure cleaner is enabled by default. The closure cleaner removes unneeded references to the surrounding class of anonymous functions inside Flink programs.
+- **`enableClosureCleaner()`** / **`disableClosureCleaner()`**. The closure cleaner is enabled by default. The closure cleaner removes unneeded references to the surrounding class of anonymous functions inside Flink programs.
--- End diff --
@zentol I wasn't aware of that convention in all honesty, thank you for pointing it out.
---
[GitHub] flink pull request #4666: [FLINK-7613][Documentation] Fixed typographical er...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4666#discussion_r139635706
--- Diff: docs/dev/datastream_api.md ---
@@ -497,7 +497,9 @@ env.generateSequence(1,10).map(new MyMapper()).setBufferTimeout(timeoutMillis);
LocalStreamEnvironment env = StreamExecutionEnvironment.createLocalEnvironment
env.setBufferTimeout(timeoutMillis)
-env.genereateSequence(1,10).map(myMap).setBufferTimeout(timeoutMillis)
+def myMap : Long => Long = _ + 1 // `generateSequence` returns a `DataStream[Long]` type
--- End diff --
This change makes the java/scala documentation inconsistent. The fact that generateSequence returns longs is also irrelevant to this section as it is about setting the buffer timeout.
---