Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Struct Documentation: Also squash down docs from sub structures #74

Open
azr opened this issue Aug 17, 2021 · 0 comments
Open

Struct Documentation: Also squash down docs from sub structures #74

azr opened this issue Aug 17, 2021 · 0 comments
Labels

Comments

@azr
Copy link
Contributor

azr commented Aug 17, 2021

A lot of fields from embedded structs are "mapstructure squashed" down for Packer. This allows to reutilize features/fields from different structs. When generating docs from these, the documentation for those fields is not automatically squashed but created in another file, resulting in possible loss of information. One fix for this would be to import the sub structs at a later step, but this being quite manual, we tend to forget things.

I think that it could be a better idea to just generate docs of squashed fields directly inline.

A good example for that is the SSHTemporaryKeyPair struct that is used by the SSH comminactor/struct but not documented anywhere.

related: linode/packer-plugin-linode#18
related: hashicorp/packer#10101

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

No branches or pull requests

2 participants