[
https://issues.apache.org/jira/browse/BEAM-6113?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Beam JIRA Bot updated BEAM-6113:
--------------------------------
Labels: documentation stale-assigned usability (was: documentation
usability)
> Streamline beam.Init() requirement for Go pipelines.
> ----------------------------------------------------
>
> Key: BEAM-6113
> URL: https://issues.apache.org/jira/browse/BEAM-6113
> Project: Beam
> Issue Type: Improvement
> Components: sdk-go
> Reporter: Daniel Oliveira
> Assignee: Daniel Oliveira
> Priority: P3
> Labels: documentation, stale-assigned, usability
> Time Spent: 1h
> Remaining Estimate: 0h
>
> When writing a Go pipeline it's necessary to call beam.Init() at the
> beginning of your code, but right now there is nearly no validation or
> checking around that. This makes it very easy for a new user of Beam Go to
> accidentally leave it out and not get a clear signal for why their pipeline
> isn't being executed as expected. This issue is for tracking progress towards
> streamlining this requirement to improve the user experience.
> In the short term this can be easily improved by improving documentation and
> examples to clearly communicate the necessity of beam.Init(), and also add
> log warnings to provide some signal if the user forgot to call it.
> In the long term, the best solution to this would be to try avoiding the
> problem all together (for example by removing the need for beam.Init(), or
> having it called implicitly without relying on users to call it), or to
> create a stronger failure state, for example by having pipelines without
> beam.Init() immediately break with a clear message notifying the user that it
> was not called.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
