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.

Sign up for GitHub

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

Jump to bottom

Document Elem: &schema.Resource{} #601

Closed
innovate-invent opened this issue Sep 29, 2020 · 1 comment · Fixed by #912
Closed

Document Elem: &schema.Resource{} #601

innovate-invent opened this issue Sep 29, 2020 · 1 comment · Fixed by #912
Assignees
@bflad
Labels
documentation Improvements or additions to documentation subsystem/types Issues and feature requests related to the type system of Terraform and our shims around it.
Milestone
v2.13.0

Comments

@innovate-invent
Copy link

Proposal

Expand documentation of the functionality referred to here:

terraform-plugin-sdk/helper/schema/schema.go

Lines 149 to 150 in 35d7fcb

// If it is *Resource, the element type is a complex structure,
// potentially managed via its own CRUD actions on the API.

It is unclear how this is used or its purpose. Searching around, there seems to be a number of posts that would benefit from this documentation in some way.
@innovate-invent innovate-invent added the enhancement New feature or request label Sep 29, 2020
@innovate-invent innovate-invent mentioned this issue Nov 3, 2020
Open
@paddycarver paddycarver added the subsystem/types Issues and feature requests related to the type system of Terraform and our shims around it. label Jan 6, 2021
@bflad bflad added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 15, 2022
@bflad bflad modified the milestones: v2.12.0, v2.13.0 Mar 15, 2022
@bflad bflad self-assigned this Mar 22, 2022
bflad added a commit that referenced this issue Mar 23, 2022
@bflad
helper/schema: Additional Go documentation for Resource and Schema types
cf3b495 
Reference: #467
Reference: #601
Reference: #735

This also spends some cycles fixing the Go documentation for struct fields to be aligned with each field individually, so pkg.go.dev and the Go language server can appropriately show the matching documentation.
@bflad bflad mentioned this issue Mar 23, 2022
Merged
bflad added a commit that referenced this issue Mar 23, 2022
@bflad
helper/schema: Additional Go documentation for Resource and Schema ty…
8c490f2 
…pes (#912)

Reference: #467
Reference: #601
Reference: #705
Reference: #735

This also spends some cycles fixing the Go documentation for struct fields to be aligned with each field individually, so pkg.go.dev and the Go language server can appropriately show the matching documentation.
@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@bflad bflad

Labels
documentation Improvements or additions to documentation subsystem/types Issues and feature requests related to the type system of Terraform and our shims around it.
Projects
None yet
Milestone
v2.13.0
3 participants
@paddycarver @bflad @innovate-invent