[
https://issues.apache.org/jira/browse/BEAM-10253?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17548718#comment-17548718
]
Danny McCormick commented on BEAM-10253:
----------------------------------------
This issue has been migrated to https://github.com/apache/beam/issues/20341
> Improve beam package GoDoc with examples.
> -----------------------------------------
>
> Key: BEAM-10253
> URL: https://issues.apache.org/jira/browse/BEAM-10253
> Project: Beam
> Issue Type: Improvement
> Components: sdk-go
> Reporter: Robert Burke
> Priority: P3
>
> The [beam package
> godoc|https://godoc.org/github.com/apache/beam/sdks/go/pkg/beam?utm_source=backtogodoc]
> needs some improvements.
> @lostluck wrote some for internal use at Google, but it hasn't yet migrated
> out.
> Even without these, godoc provides a few nice functions like [compileable
> examples|https://blog.golang.org/examples] and
> [more|https://pkg.go.dev/github.com/fluhus/godoc-tricks?tab=doc] of which we
> have made light use.
> Given the complexity of the API, we could use more.
> In particular, calling out the Bundle Lifecycle method names for Structural
> DoFns, and the method names for Structural CombineFns would be of immense
> value, as that's not clearly documented.
> Also, examples of how to use GroupByKey and CoGroupByKey and what that means
> for the subsequent DoFn methods, and how they affect Side Inputs.
> As examples are run during tests, this will also improve testing of various
> edge cases, to be part of the package.
> The main complication is that these will require _example.go files since
> methods cannot be added to types in function scopes.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
