Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-4156

[Go-SDK] Add light example output helpers for documentation

Details

    • Improvement
    • Status: Open
    • P3
    • Resolution: Unresolved
    • None
    • None
    • sdk-go
    • None

    Description

      Go has facilities to have "live" examples that run as part of the test suite, and are incorporated directly into the package documentation. These can also sanity check that text sent to STDOUT matches an expected set of lines.

      This task has two desired components:

      • A way to run the direct runner with significantly fewer lines of debugging output.
      • A light type checker that outputs PCollection types. 

      These would permit more expressive examples, and turn examples into tests. This also avoids oddities such as unused variables that need to be assigned to  _ to satisfy the Go Compiler. ("_ = foo_unused").

      Attachments

        Activity

          People

            Unassigned Unassigned
            lostluck Robert Burke
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: