Skip to content

Go SDK docs do not compile against the SDK #46

Description

@justinmclean

The Go code on both SDK doc pages does not compile.

docs/sdk/go/intro.mdx imports github.com/apache/iggy/foreign/go, which is a
module path with no package at its root, then calls iggy.NewClient, Login, a
three-argument CreateTopic, and SendMessages with [][]byte. None of those
functions exist in the SDK.

docs/sdk/go/examples.mdx uses the right imports and constructor but omits the
context argument on every call and never calls Connect.

Reproduced by extracting the three snippets into and running go vet:

  • intro: no required module provides package github.com/apache/iggy/foreign/go
  • producer and consumer: not enough arguments in call to cli.LoginUser: have (string, string), want (context.Context, string, string)

Two smaller problems in the same code: stream and topic creation abort on a
second run, and the producer sends ten messages while printing nothing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions