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

Error in Python zip_with_index documentation

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.3.0
    • Fix Version/s: 1.3.0
    • Component/s: Documentation, Python API
    • Labels:
      None

      Description

      At https://ci.apache.org/projects/flink/flink-docs-release-1.3/dev/batch/zip_elements_guide.html, under "Zip with a Dense Index," the Python example shows using the camelcase-named zipWithIndex method, when in reality the proper method name is in snake case (zip_with_index). This is an error from my merged pull request which added zip_with_index to the Python API (https://github.com/apache/flink/pull/2136/files#diff-635d49f032b2e71bd334e89368e93afeR77).

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/3454
          Hide
          Zentol Chesnay Schepler added a comment -

          Fixed in 82047f7230fc4c19eded993e0fc14ee99fa8044e.

          Show
          Zentol Chesnay Schepler added a comment - Fixed in 82047f7230fc4c19eded993e0fc14ee99fa8044e.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

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

          merging

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/3454 merging
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

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

          Nice catch, +1 to merge.

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/3454 Nice catch, +1 to merge.
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user GEOFBOT opened a pull request:

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

          FLINK-5948 Fix error in Python zip_with_index documentation

          Fixes an issue with the documentation where the camel-cased name `zipWithIndex` is used instead of the snake-cased name (`zip_with_index`).

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

          $ git pull https://github.com/GEOFBOT/flink FLINK-5948

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

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


          commit ca0e5c69e582c1aebca8ebb7e2c24c632d4491c9
          Author: Geoffrey Mon <geofbot@gmail.com>
          Date: 2017-03-02T03:50:51Z

          FLINK-5948 Fix error in Python zip_with_index documentation


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user GEOFBOT opened a pull request: https://github.com/apache/flink/pull/3454 FLINK-5948 Fix error in Python zip_with_index documentation Fixes an issue with the documentation where the camel-cased name `zipWithIndex` is used instead of the snake-cased name (`zip_with_index`). You can merge this pull request into a Git repository by running: $ git pull https://github.com/GEOFBOT/flink FLINK-5948 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3454.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 #3454 commit ca0e5c69e582c1aebca8ebb7e2c24c632d4491c9 Author: Geoffrey Mon <geofbot@gmail.com> Date: 2017-03-02T03:50:51Z FLINK-5948 Fix error in Python zip_with_index documentation

            People

            • Assignee:
              Unassigned
              Reporter:
              hydronium Geoffrey Mon
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development