You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beam.apache.org by Joey Tran <jo...@schrodinger.com> on 2024/07/03 17:38:01 UTC
Beam Example Bugs
There are a handful of bugs with the interactive examples on the Beam docs
page
https://beam.apache.org/documentation/transforms/python/elementwise/flatmap/#example-3-flatmap-without-a-function
https://beam.apache.org/documentation/transforms/python/elementwise/map/
(example 8)
I wonder if it might be worthwhile to add website/playground validation to
the Release Validation process? Not sure how onerous this would be. A new
team I introduced to Beam noted that the unreliable examples was a pain
point for them.
Cheers,
Joey
Re: [EXTERNAL] Re: Beam Example Bugs
Posted by Vitaly Terentyev via dev <de...@beam.apache.org>.
Created a new issue: https://github.com/apache/beam/issues/31780.
Best regards,
Vitaly
________________________________
From: Robert Bradshaw via dev <de...@beam.apache.org>
Sent: Wednesday, 3 July 2024 11:12:49 PM
To: dev@beam.apache.org
Cc: Robert Bradshaw
Subject: [EXTERNAL] Re: Beam Example Bugs
We should be validating as much of our documentation as possible in
our testing, e.g.
https://github.com/apache/beam/tree/master/sdks/python/apache_beam/examples/snippets
is where the actual code and examples on our website (for Python)
lives to ensure it is regularly tested (on each PR) doesn't bitrot.
But if there are things that are not being validated we should try to
add that.
On Wed, Jul 3, 2024 at 11:37 AM Valentyn Tymofieiev via dev
<de...@beam.apache.org> wrote:
>
> Thanks for flagging this Joey, I reopened https://github.com/apache/beam/issues/31624.
>
> We can certainly validate any aspect of Beam during the release. I think it should be possible to detect issues like this in a website/playground test suite, and include that suite in the list of postcommit suites we watch during the release. Then it will be periodically looked at, even if these errors might not be release-blocking because playground is not a part of released artifacts.
>
>
> On Wed, Jul 3, 2024 at 10:41 AM Joey Tran <jo...@schrodinger.com> wrote:
>>
>> There are a handful of bugs with the interactive examples on the Beam docs page
>>
>> https://beam.apache.org/documentation/transforms/python/elementwise/flatmap/#example-3-flatmap-without-a-function
>> https://beam.apache.org/documentation/transforms/python/elementwise/map/
>> (example 8)
>>
>> I wonder if it might be worthwhile to add website/playground validation to the Release Validation process? Not sure how onerous this would be. A new team I introduced to Beam noted that the unreliable examples was a pain point for them.
>>
>> Cheers,
>> Joey
Re: Beam Example Bugs
Posted by Robert Bradshaw via dev <de...@beam.apache.org>.
We should be validating as much of our documentation as possible in
our testing, e.g.
https://github.com/apache/beam/tree/master/sdks/python/apache_beam/examples/snippets
is where the actual code and examples on our website (for Python)
lives to ensure it is regularly tested (on each PR) doesn't bitrot.
But if there are things that are not being validated we should try to
add that.
On Wed, Jul 3, 2024 at 11:37 AM Valentyn Tymofieiev via dev
<de...@beam.apache.org> wrote:
>
> Thanks for flagging this Joey, I reopened https://github.com/apache/beam/issues/31624.
>
> We can certainly validate any aspect of Beam during the release. I think it should be possible to detect issues like this in a website/playground test suite, and include that suite in the list of postcommit suites we watch during the release. Then it will be periodically looked at, even if these errors might not be release-blocking because playground is not a part of released artifacts.
>
>
> On Wed, Jul 3, 2024 at 10:41 AM Joey Tran <jo...@schrodinger.com> wrote:
>>
>> There are a handful of bugs with the interactive examples on the Beam docs page
>>
>> https://beam.apache.org/documentation/transforms/python/elementwise/flatmap/#example-3-flatmap-without-a-function
>> https://beam.apache.org/documentation/transforms/python/elementwise/map/
>> (example 8)
>>
>> I wonder if it might be worthwhile to add website/playground validation to the Release Validation process? Not sure how onerous this would be. A new team I introduced to Beam noted that the unreliable examples was a pain point for them.
>>
>> Cheers,
>> Joey
Re: Beam Example Bugs
Posted by Valentyn Tymofieiev via dev <de...@beam.apache.org>.
Thanks for flagging this Joey, I reopened
https://github.com/apache/beam/issues/31624.
We can certainly validate any aspect of Beam during the release. I think it
should be possible to detect issues like this in a website/playground test
suite, and include that suite in the list of postcommit suites we watch
during the release. Then it will be periodically looked at, even if these
errors might not be release-blocking because playground is not a part of
released artifacts.
On Wed, Jul 3, 2024 at 10:41 AM Joey Tran <jo...@schrodinger.com> wrote:
> There are a handful of bugs with the interactive examples on the Beam docs
> page
>
>
> https://beam.apache.org/documentation/transforms/python/elementwise/flatmap/#example-3-flatmap-without-a-function
> https://beam.apache.org/documentation/transforms/python/elementwise/map/
> (example 8)
>
> I wonder if it might be worthwhile to add website/playground validation to
> the Release Validation process? Not sure how onerous this would be. A new
> team I introduced to Beam noted that the unreliable examples was a pain
> point for them.
>
> Cheers,
> Joey
>