You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
The text was updated successfully, but these errors were encountered: