bug: attribute descriptions are not rendered in read-only nested block about terraform-plugin-docs

[sergiught]

We're hitting the same issue, it would be nice to actually get some support from HashiCorp on this.

[Shocktrooper]

I also have run into this and was wondering when the fix would be implemented as having descriptions on nested blocks would be nice for end users

[stevenpaz]

I too have run into this issue. Upgraded to the latest (v0.13.0 at the time of this comment) but still seeing it.

[mavogel]

Hi folks, after some digging I guess the bug is in terraform-json which this tool uses as input. For more details see the issue here: hashicorp/terraform-json#65

[mavogel]

@bookshelfdave will you take over from here on? As Radek suggested in hashicorp/terraform-json#65 it could also be an issue in the https://github.com/hashicorp/terraform-plugin-sdk repo. Also the bug still exists for

terraform-plugin-docs: v0.13.0
terraform-plugin-sdk/v2 v2.24.1

[sergiught]

Would it be possible to get any ETA on this @bookshelfdave, @austinvalle? 🙏🏻

[bookshelfdave]

Hello - my apologies for the delay on this issue. Unfortunately, it is not something we can fix as part of terraform-plugin-docs. Object attributes in Terraform do not have descriptions, so there isn't a valid source for this info. This is not a limitation in Terraform Plugin Framework-based providers when using Nested Attributes.

[sergiught]

Understood, thanks for the clarity on this one @bookshelfdave 👍🏻

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.