Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-6512

some code examples are poorly formatted

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Implemented
    • Affects Version/s: 1.3.0, 1.2.1
    • Fix Version/s: 1.3.0, 1.2.2, 1.4.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      Some code examples in the docs are hard to read, mostly because the code highlighting plugin was overlooked.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-6512[docs] improved code formatting in some examples

          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](http://flink.apache.org/how-to-contribute.html).
          In addition to going through the list, please provide a meaningful description of your changes.

          • [x] 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)

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

          $ git pull https://github.com/alpinegizmo/flink 6512-code-formatting

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

          https://github.com/apache/flink/pull/3857.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 #3857


          commit b3a3af7d92fb1f33a20cbfe2ca8c9bee76263542
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-05-09T15:23:46Z

          FLINK-6512[docs] improved code formatting in some examples


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3857 FLINK-6512 [docs] improved code formatting in some examples 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] ( http://flink.apache.org/how-to-contribute.html ). In addition to going through the list, please provide a meaningful description of your changes. [x] 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) You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink 6512-code-formatting Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3857.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 #3857 commit b3a3af7d92fb1f33a20cbfe2ca8c9bee76263542 Author: David Anderson <david@alpinegizmo.com> Date: 2017-05-09T15:23:46Z FLINK-6512 [docs] improved code formatting in some examples
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on the issue:

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

          @alpinegizmo is there a standard use here for tabs and spaces? This looks to assume that 1 tab = 8 spaces. If tabs are forcing too large and indentation why not use spaces everyone?

          Show
          githubbot ASF GitHub Bot added a comment - Github user greghogan commented on the issue: https://github.com/apache/flink/pull/3857 @alpinegizmo is there a standard use here for tabs and spaces? This looks to assume that 1 tab = 8 spaces. If tabs are forcing too large and indentation why not use spaces everyone?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user alpinegizmo commented on the issue:

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

          @greghogan Yes, I think we should use spaces rather than tabs in code samples in the docs – and fewer than 8. I looked around at all of the code in the docs, and made sure that all of it is now inside of a code highlighting block. I only changed indentation in cases where it really bothered me. Making the indentation 100% consistent didn't seem worth the trouble, and wouldn't very enforceable going forward (unless the highlight plugin is capable of doing the indentation for us).

          Show
          githubbot ASF GitHub Bot added a comment - Github user alpinegizmo commented on the issue: https://github.com/apache/flink/pull/3857 @greghogan Yes, I think we should use spaces rather than tabs in code samples in the docs – and fewer than 8. I looked around at all of the code in the docs, and made sure that all of it is now inside of a code highlighting block. I only changed indentation in cases where it really bothered me. Making the indentation 100% consistent didn't seem worth the trouble, and wouldn't very enforceable going forward (unless the highlight plugin is capable of doing the indentation for us).
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on the issue:

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

          @alpinegizmo changes look good. Merging ...

          Show
          githubbot ASF GitHub Bot added a comment - Github user greghogan commented on the issue: https://github.com/apache/flink/pull/3857 @alpinegizmo changes look good. Merging ...
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/3857
          Hide
          greghogan Greg Hogan added a comment -

          master: 8a8d95e31132889ea5cc3423ea50280fbaf47062
          release-1.3: 81b6c82142ad1c4a8c1288bff754840c65ec4059
          release-1.2: 9fbd08b58f4ead2dddcc283f99385fa5be94eecf

          Show
          greghogan Greg Hogan added a comment - master: 8a8d95e31132889ea5cc3423ea50280fbaf47062 release-1.3: 81b6c82142ad1c4a8c1288bff754840c65ec4059 release-1.2: 9fbd08b58f4ead2dddcc283f99385fa5be94eecf

            People

            • Assignee:
              alpinegizmo David Anderson
              Reporter:
              alpinegizmo David Anderson
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development