You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by alpinegizmo <gi...@git.apache.org> on 2016/09/20 12:58:48 UTC

[GitHub] flink pull request #2519: [docs] Small improvements to the docs.

GitHub user alpinegizmo opened a pull request:

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

    [docs] Small improvements to the docs.

    This pull request only affects documentation -- fixing small mistakes and improving awkward phrases.

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

    $ git pull https://github.com/alpinegizmo/flink master

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

    https://github.com/apache/flink/pull/2519.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 #2519
    
----
commit d6af10b62e6094c879805f6395b891f616a098e3
Author: David Anderson <da...@alpinegizmo.com>
Date:   2016-09-20T12:54:44Z

    [docs] Small improvements to the docs.

----


---
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.
---

[GitHub] flink pull request #2519: [docs] Small improvements to the docs.

Posted by alpinegizmo <gi...@git.apache.org>.
Github user alpinegizmo closed the pull request at:

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


---
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.
---

[GitHub] flink pull request #2519: [docs] Small improvements to the docs.

Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:

    https://github.com/apache/flink/pull/2519#discussion_r79655043
  
    --- Diff: docs/quickstart/run_example_quickstart.md ---
    @@ -125,21 +125,21 @@ public class WikipediaAnalysis {
     }
     {% endhighlight %}
     
    -I admit it's very bare bones now but we will fill it as we go. Note, that I'll not give
    +I admit it's very bare bones now but we will fill it as we go. Note that I'll not give
     import statements here since IDEs can add them automatically. At the end of this section I'll show
     the complete code with import statements if you simply want to skip ahead and enter that in your
     editor.
     
     The first step in a Flink program is to create a `StreamExecutionEnvironment`
     (or `ExecutionEnvironment` if you are writing a batch job). This can be used to set execution
    -parameters and create sources for reading from external systems. So let's go ahead, add
    +parameters and create sources for reading from external systems. So let's go ahead, and add
    --- End diff --
    
    Remove the comma? "go ahead and add"


---
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.
---

[GitHub] flink pull request #2519: [docs] Small improvements to the docs.

Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:

    https://github.com/apache/flink/pull/2519#discussion_r79655828
  
    --- Diff: docs/quickstart/run_example_quickstart.md ---
    @@ -277,8 +277,8 @@ The number in front of each line tells you on which parallel instance of the pri
     was produced.
     
     This should get you started with writing your own Flink programs. You can check out our guides
    -about [basic concepts]{{{ site.baseurl }}/apis/common/index.html} and the
    -[DataStream API]{{{ site.baseurl }}/apis/streaming/index.html} if you want to learn more. Stick
    +about [basic concepts]({{ site.baseurl }}/apis/common/index.html) and the
    +[DataStream API]({{ site.baseurl }}/apis/streaming/index.html) if you want to learn more. Stick
    --- End diff --
    
    "if you want to learn more" -> "to learn more"
    
    We can assume our users want to learn more :)


---
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.
---

[GitHub] flink pull request #2519: [docs] Small improvements to the docs.

Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:

    https://github.com/apache/flink/pull/2519#discussion_r79654882
  
    --- Diff: docs/quickstart/run_example_quickstart.md ---
    @@ -125,21 +125,21 @@ public class WikipediaAnalysis {
     }
     {% endhighlight %}
     
    -I admit it's very bare bones now but we will fill it as we go. Note, that I'll not give
    +I admit it's very bare bones now but we will fill it as we go. Note that I'll not give
    --- End diff --
    
    "bare bones" -> "basic"? Or perhaps "The program is very basic now but we will fill it in ..."


---
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.
---