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

helper/schema: Remove Default mention from Schema type Optional field Go documentation #1188

Merged
merged 1 commit into from
Apr 10, 2023

Conversation

bflad
Copy link
Member

@bflad bflad commented Apr 10, 2023

Closes #1185

While the intention of the Go documentation matches Terraform's expectations, other parts of the SDK explicitly validate against the schema definition it was recommending. This documentation change is safer than trying to reconcile all the potential behavior changes should this particular validation be removed and a developer attempts to set Computed.

… Go documentation

Reference: #1185

While the intention of the Go documentation matches Terraform's expectations, other parts of the SDK explicitly validate against the schema definition it was recommending. This documentation change is safer than trying to reconcile all the potential behavior changes should this particular validation be removed and a developer attempts to set `Computed`.
@bflad bflad added the documentation Improvements or additions to documentation label Apr 10, 2023
@bflad bflad requested a review from a team as a code owner April 10, 2023 18:01
Copy link
Member

@austinvalle austinvalle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 👍🏻

@bflad bflad added this to the v2.27.0 milestone Apr 10, 2023
@bflad bflad merged commit 8898c1a into main Apr 10, 2023
5 checks passed
@bflad bflad deleted the bflad/schema-optional-docs branch April 10, 2023 21:20
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, 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 May 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent Optional w/ Default behavior
2 participants