You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/07/22 09:28:07 UTC
[GitHub] [beam] mosche opened a new pull request, #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
mosche opened a new pull request, #22409:
URL: https://github.com/apache/beam/pull/22409
While still experimental and in a "pre alpha" phase with lots of changes to expect, it's probably not a good idea to publish Javadocs for the `SparkStructuredStreamingRunner` yet. Likely it will just confuse users.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] mosche closed pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
mosche closed pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
URL: https://github.com/apache/beam/pull/22409
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aromanenko-dev commented on pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
aromanenko-dev commented on PR #22409:
URL: https://github.com/apache/beam/pull/22409#issuecomment-1194079110
I'd agree to not have these Javadocs if they have not been published yet. For now, until we have these classes available for users (even if we are 99% sure that they mostly not used), I'd prefer to keep them for a sake of integrality since Beam still provide them.
> IMHO, with almost absolute certainty, you can count on the fact that every single user looking for Spark runner related Javadocs isn't looking for the ones of the SparkStructuredStreamingRunner.
Agree but it also means that they very likely won't be confused or mislead with that =) To annotate them `@Experimental`, as I proposed before, will make it easier to change the naming or other API changes in the future.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] mosche commented on pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
mosche commented on PR #22409:
URL: https://github.com/apache/beam/pull/22409#issuecomment-1192373423
R: @echauchot
R: @aromanenko-dev
(just a tiny gradle config)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] mosche commented on pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
mosche commented on PR #22409:
URL: https://github.com/apache/beam/pull/22409#issuecomment-1194100053
ok, not worth having a discussion on this ... closing it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] mosche commented on pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
mosche commented on PR #22409:
URL: https://github.com/apache/beam/pull/22409#issuecomment-1194020829
IMHO, with almost absolute certainty, you can count on the fact that every single user looking for Spark runner related Javadocs isn't looking for the ones of the SparkStructuredStreamingRunner. Also, the RDD runner is at least conscious about which Javadocs get published. All translation classes, the user should never interact with, are explicitly excluded and hidden there.
The other side to this is the pure amount of breaking changes to expect... most critical, expecting a new name (and package structure) for the runner. IMHO, regardless of the status quo, having these Javadocs there is by far more harmful than helpful.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #22409:
URL: https://github.com/apache/beam/pull/22409#issuecomment-1192400015
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] mosche commented on pull request #22409: Exclude javadocs for experimental SparkStructuredStreamingRunner
Posted by GitBox <gi...@apache.org>.
mosche commented on PR #22409:
URL: https://github.com/apache/beam/pull/22409#issuecomment-1194092568
> Agree but it also means that they very likely won't be confused or mislead with that =)
Actually, isn't it the opposite? Users are looking for Javadocs of the RDD Spark runner but find themselves having to Javadocs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org