Skip to content

README.md Example Should Include Imports #199

@steve-gray

Description

@steve-gray

The code in the README.md doesn't specify the namespaces/packages to import Client or other objects from with illustrative import statements.

Given the very strange way this package has gone to lengths to make it pull all the sub-packages in the initial go get (the root package is essentially empty with nothing more than a bunch of underscored references to other sub-packages...), it's even stranger that there's no examples folder, or a hint as to what package Client refers to.

Would suggest:

  • Add imports statements to the README.md examples

  • Add an /examples folder showing a few basic scenarios.

  • Remove the underscored imports. Go will automatically lock in the sub-packages, however this approach will mean that go get / go mod vendor will always include all the subtrees for components you might not even be using (i.e. if you're not using legacy/firstgen).

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