Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

README.md Example Should Include Imports #199

Open
steve-gray opened this issue Oct 22, 2022 · 0 comments
Open

README.md Example Should Include Imports #199

steve-gray opened this issue Oct 22, 2022 · 0 comments

Comments

@steve-gray
Copy link

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).

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant