Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 0.8.4
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      All public classes should have ScalaDoc and any warnings should be fixed.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user manuzhang opened a pull request:

          https://github.com/apache/incubator-gearpump/pull/210

          GEARPUMP-339 Fix unknown tag parameter

          Be sure to do all of the following to help us incorporate your contribution
          quickly and easily:

          • [ ] Make sure the commit message is formatted like:
            `GEARPUMP-<Jira issue #> Meaningful description of pull request`
          • [ ] Make sure tests pass via `sbt clean test`.
          • [ ] Make sure old documentation affected by the pull request has been updated and new documentation added for new functionality.

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

          $ git pull https://github.com/manuzhang/incubator-gearpump improve_scaladoc

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

          https://github.com/apache/incubator-gearpump/pull/210.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 #210


          commit c9759ba5edb1ab7b9c5d81e2f0810a8f4712b256
          Author: manuzhang <owenzhang1990@gmail.com>
          Date: 2017-08-05T09:41:31Z

          GEARPUMP-339 Fix unknown tag parameter


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user manuzhang opened a pull request: https://github.com/apache/incubator-gearpump/pull/210 GEARPUMP-339 Fix unknown tag parameter Be sure to do all of the following to help us incorporate your contribution quickly and easily: [ ] Make sure the commit message is formatted like: ` GEARPUMP-<Jira issue #> Meaningful description of pull request` [ ] Make sure tests pass via `sbt clean test`. [ ] Make sure old documentation affected by the pull request has been updated and new documentation added for new functionality. You can merge this pull request into a Git repository by running: $ git pull https://github.com/manuzhang/incubator-gearpump improve_scaladoc Alternatively you can review and apply these changes as the patch at: https://github.com/apache/incubator-gearpump/pull/210.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 #210 commit c9759ba5edb1ab7b9c5d81e2f0810a8f4712b256 Author: manuzhang <owenzhang1990@gmail.com> Date: 2017-08-05T09:41:31Z GEARPUMP-339 Fix unknown tag parameter
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user huafengw commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/210

          LGTM

          Show
          githubbot ASF GitHub Bot added a comment - Github user huafengw commented on the issue: https://github.com/apache/incubator-gearpump/pull/210 LGTM
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/210

          @huafengw Unfortunately, [genjavadoc doesn't support translating tparam tag](https://github.com/typesafehub/genjavadoc/issues/65). I will record this in jira and let's revisit when it's supported.

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang commented on the issue: https://github.com/apache/incubator-gearpump/pull/210 @huafengw Unfortunately, [genjavadoc doesn't support translating tparam tag] ( https://github.com/typesafehub/genjavadoc/issues/65 ). I will record this in jira and let's revisit when it's supported.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang closed the pull request at:

          https://github.com/apache/incubator-gearpump/pull/210

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang closed the pull request at: https://github.com/apache/incubator-gearpump/pull/210
          Hide
          mauzhang Manu Zhang added a comment -

          genjavadoc doesn't support translating tparam tag so we have to put up with Intellij complaining "Unknown Tag Parameter" or disable the inspection.

          Show
          mauzhang Manu Zhang added a comment - genjavadoc doesn't support translating tparam tag so we have to put up with Intellij complaining "Unknown Tag Parameter" or disable the inspection.
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user manuzhang opened a pull request:

          https://github.com/apache/incubator-gearpump/pull/212

          GEARPUMP-339 Add ScalaDoc to Streaming DSL

          Be sure to do all of the following to help us incorporate your contribution
          quickly and easily:

          • [ ] Make sure the commit message is formatted like:
            `GEARPUMP-<Jira issue #> Meaningful description of pull request`
          • [ ] Make sure tests pass via `sbt clean test`.
          • [ ] Make sure old documentation affected by the pull request has been updated and new documentation added for new functionality.

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

          $ git pull https://github.com/manuzhang/incubator-gearpump plan_doc

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

          https://github.com/apache/incubator-gearpump/pull/212.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 #212


          commit c2446fb54fce1ce727243be45391710d4a0dee0f
          Author: manuzhang <owenzhang1990@gmail.com>
          Date: 2017-08-05T16:56:18Z

          GEARPUMP-339 Add ScalaDoc to Streaming DSL


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user manuzhang opened a pull request: https://github.com/apache/incubator-gearpump/pull/212 GEARPUMP-339 Add ScalaDoc to Streaming DSL Be sure to do all of the following to help us incorporate your contribution quickly and easily: [ ] Make sure the commit message is formatted like: ` GEARPUMP-<Jira issue #> Meaningful description of pull request` [ ] Make sure tests pass via `sbt clean test`. [ ] Make sure old documentation affected by the pull request has been updated and new documentation added for new functionality. You can merge this pull request into a Git repository by running: $ git pull https://github.com/manuzhang/incubator-gearpump plan_doc Alternatively you can review and apply these changes as the patch at: https://github.com/apache/incubator-gearpump/pull/212.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 #212 commit c2446fb54fce1ce727243be45391710d4a0dee0f Author: manuzhang <owenzhang1990@gmail.com> Date: 2017-08-05T16:56:18Z GEARPUMP-339 Add ScalaDoc to Streaming DSL
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/212

          R: @huafengw

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang commented on the issue: https://github.com/apache/incubator-gearpump/pull/212 R: @huafengw
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user huafengw commented on a diff in the pull request:

          https://github.com/apache/incubator-gearpump/pull/212#discussion_r131545040

          — Diff: streaming/src/main/scala/org/apache/gearpump/streaming/dsl/scalaapi/StreamApp.scala —
          @@ -62,6 +62,17 @@ class StreamApp(
          val dag = planner.plan(graph)
          StreamApplication(name, dag, userConfig)
          }
          +
          + def source[T](dataSource: DataSource, parallelism: Int = 1,
          + conf: UserConfig = UserConfig.empty, description: String = "source"): Stream[T] = {
          + implicit val sourceOp = DataSourceOp(dataSource, parallelism, description, conf)
          — End diff –

          Has to be implicit?

          Show
          githubbot ASF GitHub Bot added a comment - Github user huafengw commented on a diff in the pull request: https://github.com/apache/incubator-gearpump/pull/212#discussion_r131545040 — Diff: streaming/src/main/scala/org/apache/gearpump/streaming/dsl/scalaapi/StreamApp.scala — @@ -62,6 +62,17 @@ class StreamApp( val dag = planner.plan(graph) StreamApplication(name, dag, userConfig) } + + def source [T] (dataSource: DataSource, parallelism: Int = 1, + conf: UserConfig = UserConfig.empty, description: String = "source"): Stream [T] = { + implicit val sourceOp = DataSourceOp(dataSource, parallelism, description, conf) — End diff – Has to be implicit?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user huafengw commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/212

          Generally LGTM

          Show
          githubbot ASF GitHub Bot added a comment - Github user huafengw commented on the issue: https://github.com/apache/incubator-gearpump/pull/212 Generally LGTM
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/incubator-gearpump/pull/212

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/incubator-gearpump/pull/212
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user manuzhang opened a pull request:

          https://github.com/apache/incubator-gearpump/pull/213

          GEARPUMP-339 Add ScalaDoc to window api and impl

          Be sure to do all of the following to help us incorporate your contribution
          quickly and easily:

          • [ ] Make sure the commit message is formatted like:
            `GEARPUMP-<Jira issue #> Meaningful description of pull request`
          • [ ] Make sure tests pass via `sbt clean test`.
          • [ ] Make sure old documentation affected by the pull request has been updated and new documentation added for new functionality.

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

          $ git pull https://github.com/manuzhang/incubator-gearpump add_window_doc

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

          https://github.com/apache/incubator-gearpump/pull/213.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 #213


          commit 7acd22e71880083800b914f83ec201151b9c583d
          Author: manuzhang <owenzhang1990@gmail.com>
          Date: 2017-08-13T04:04:00Z

          GEARPUMP-339 Add ScalaDoc to window api and impl


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user manuzhang opened a pull request: https://github.com/apache/incubator-gearpump/pull/213 GEARPUMP-339 Add ScalaDoc to window api and impl Be sure to do all of the following to help us incorporate your contribution quickly and easily: [ ] Make sure the commit message is formatted like: ` GEARPUMP-<Jira issue #> Meaningful description of pull request` [ ] Make sure tests pass via `sbt clean test`. [ ] Make sure old documentation affected by the pull request has been updated and new documentation added for new functionality. You can merge this pull request into a Git repository by running: $ git pull https://github.com/manuzhang/incubator-gearpump add_window_doc Alternatively you can review and apply these changes as the patch at: https://github.com/apache/incubator-gearpump/pull/213.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 #213 commit 7acd22e71880083800b914f83ec201151b9c583d Author: manuzhang <owenzhang1990@gmail.com> Date: 2017-08-13T04:04:00Z GEARPUMP-339 Add ScalaDoc to window api and impl
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/213

          R: @huafengw

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang commented on the issue: https://github.com/apache/incubator-gearpump/pull/213 R: @huafengw
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user huafengw commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/213

          No unit test failed, so where does the failure come from?

          Show
          githubbot ASF GitHub Bot added a comment - Github user huafengw commented on the issue: https://github.com/apache/incubator-gearpump/pull/213 No unit test failed, so where does the failure come from?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/213

          Maybe it's killed after hanging since it took longer than usual.

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang commented on the issue: https://github.com/apache/incubator-gearpump/pull/213 Maybe it's killed after hanging since it took longer than usual.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user huafengw commented on a diff in the pull request:

          https://github.com/apache/incubator-gearpump/pull/213#discussion_r132863041

          — Diff: streaming/src/main/scala/org/apache/gearpump/streaming/dsl/window/impl/WindowRunner.scala —
          @@ -137,11 +156,14 @@ class DefaultWindowRunner[IN, OUT](
          }
          onTrigger(outputs, newWmk)
          } else

          { - // minimum of end of last triggered window and start of first un-triggered window + // The output watermark is the minimum of end of last triggered window + // and start of first un-triggered window TriggeredOutputs(outputs, TaskUtil.min(wmk, firstWin.startTime)) }

          } else {
          + // All windows have been triggered.
          if (time == Watermark.MAX) {
          + // This means there will no more inputs so it's safe to advance to the maximum watermark.
          — End diff –

          there will be no more

          Show
          githubbot ASF GitHub Bot added a comment - Github user huafengw commented on a diff in the pull request: https://github.com/apache/incubator-gearpump/pull/213#discussion_r132863041 — Diff: streaming/src/main/scala/org/apache/gearpump/streaming/dsl/window/impl/WindowRunner.scala — @@ -137,11 +156,14 @@ class DefaultWindowRunner [IN, OUT] ( } onTrigger(outputs, newWmk) } else { - // minimum of end of last triggered window and start of first un-triggered window + // The output watermark is the minimum of end of last triggered window + // and start of first un-triggered window TriggeredOutputs(outputs, TaskUtil.min(wmk, firstWin.startTime)) } } else { + // All windows have been triggered. if (time == Watermark.MAX) { + // This means there will no more inputs so it's safe to advance to the maximum watermark. — End diff – there will be no more
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang commented on a diff in the pull request:

          https://github.com/apache/incubator-gearpump/pull/213#discussion_r132863203

          — Diff: streaming/src/main/scala/org/apache/gearpump/streaming/dsl/window/impl/WindowRunner.scala —
          @@ -137,11 +156,14 @@ class DefaultWindowRunner[IN, OUT](
          }
          onTrigger(outputs, newWmk)
          } else

          { - // minimum of end of last triggered window and start of first un-triggered window + // The output watermark is the minimum of end of last triggered window + // and start of first un-triggered window TriggeredOutputs(outputs, TaskUtil.min(wmk, firstWin.startTime)) }

          } else {
          + // All windows have been triggered.
          if (time == Watermark.MAX) {
          + // This means there will no more inputs so it's safe to advance to the maximum watermark.
          — End diff –

          nice catch 😏

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang commented on a diff in the pull request: https://github.com/apache/incubator-gearpump/pull/213#discussion_r132863203 — Diff: streaming/src/main/scala/org/apache/gearpump/streaming/dsl/window/impl/WindowRunner.scala — @@ -137,11 +156,14 @@ class DefaultWindowRunner [IN, OUT] ( } onTrigger(outputs, newWmk) } else { - // minimum of end of last triggered window and start of first un-triggered window + // The output watermark is the minimum of end of last triggered window + // and start of first un-triggered window TriggeredOutputs(outputs, TaskUtil.min(wmk, firstWin.startTime)) } } else { + // All windows have been triggered. if (time == Watermark.MAX) { + // This means there will no more inputs so it's safe to advance to the maximum watermark. — End diff – nice catch 😏
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user manuzhang commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/213

          BTW, the tests passes locally and this PR doesn't touch any codes.

          Show
          githubbot ASF GitHub Bot added a comment - Github user manuzhang commented on the issue: https://github.com/apache/incubator-gearpump/pull/213 BTW, the tests passes locally and this PR doesn't touch any codes.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user huafengw commented on the issue:

          https://github.com/apache/incubator-gearpump/pull/213

          +1

          Show
          githubbot ASF GitHub Bot added a comment - Github user huafengw commented on the issue: https://github.com/apache/incubator-gearpump/pull/213 +1
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/incubator-gearpump/pull/213

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/incubator-gearpump/pull/213

            People

            • Assignee:
              mauzhang Manu Zhang
              Reporter:
              mauzhang Manu Zhang
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Development