Clean up godoc representation of packages and document code gen tool

[kortschak]

Please take a look.

To demonstrate what is being fixed, visit https://pkg.go.dev/github.com/elastic/[email protected]/gotype. This also makes generation consistent by including the generator in the mod files and fixes imports.

It looks like the code gen does not automatically place the copyright headers. If you point me to where this is done I will fix that. Thanks. Fixed

[elasticmachine]

❕ Build Aborted

The PR is not allowed to run in the CI yet

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2023-08-16T15:02:14.291+0000

• Duration: 2 min 58 sec

Steps errors

Expand to view the steps failures

Load a resource file from a library

• Took 0 min 0 sec . View more details here
• Description: approval-list/elastic/go-structform.yml

Error signal

• Took 0 min 0 sec . View more details here
• Description: githubApiCall: The REST API call https://api.github.com/orgs/elastic/members/kortschak return the message : java.lang.Exception: httpRequest: Failure connecting to the service https://api.github.com/orgs/elastic/members/kortschak : httpRequest: Failure connecting to the service https://api.github.com/orgs/elastic/members/kortschak : Code: 404Error: {"message":"User does not exist or is not a member of the organization","documentation_url":"https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user"}

[urso]

I presume most of these dependencies are introduced by the mktmpl tool.

For tools I would prefer to bingo approach instead of 'polluting' the go.mod file.

[kortschak]

Yes, that's why they're there. I'm not convinced by the claims made by bingo, but is there anything that you would like me to do with this? Either I should add a tools.go to make the changes to go.mod stable, or I can try bingo.

[urso]

Let's add a tools.go to stabilize go.mod. Thanks

[kortschak]

Done.

[urso]

All in all the change looks good to me. Thanks for contributing clean ups. Very much appreciated.

I'm just not a fan of polluting go.mod with tool dependencies. Maybe we want to give 'bingo' a try.
Besides for some benchmarks (which are disabled by default), testify should be the only dependency.

[houndci-bot]

a blank import should be only in a main or test package, or have a comment justifying it

[houndci-bot]

a blank import should be only in a main or test package, or have a comment justifying it

[urso]

/test